New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Integrate the `add_header` script in the CI/CD #4980

Closed

joeldierkes opened this issue Nov 5, 2021 · 0 comments · Fixed by #5109

Assignees

Labels

feature Testing

Milestone

Contributor

joeldierkes commented Nov 5, 2021

Motivation

Since the PR #4903 the add_header script can check for changes and return a non-zero exit code if there would be any changes in the header comment. We can include the script in the workflow and check for inconsistent headers automatically.

Modification

Run the add_header script with the --dry-run and --check option on changed python files in the workflow.

The text was updated successfully, but these errors were encountered:

joeldierkes added enhancement feature labels

joeldierkes self-assigned this

bari12 added Testing and removed enhancement labels

joeldierkes mentioned this issue

Pre commit script #4971

Merged

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

45406d3

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Sanitize the python headers Fix rucio#4980

65ce378

The headers in this project are automatically generated. A script uses the git
history to determine the current header.

Since a lot of developers did not run the script, the current state of the
repository and the desired one are different. This commit sets all the headers
to the desired state.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

122cef8

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

56085f4

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

56777a9

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Sanitize the python headers Fix rucio#4980

7c070da

The headers in this project are automatically generated. A script uses the git
history to determine the current header.

Since a lot of developers did not run the script, the current state of the
repository and the desired one are different. This commit sets all the headers
to the desired state.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Sanitize the python headers Fix rucio#4980

9b81829

The headers in this project are automatically generated. A script uses the git
history to determine the current header.

Since a lot of developers did not run the script, the current state of the
repository and the desired one are different. This commit sets all the headers
to the desired state.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

9a23c28

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

eb94745

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Sanitize the python headers Fix rucio#4980

9e048ba

The headers in this project are automatically generated. A script uses the git
history to determine the current header.

Since a lot of developers did not run the script, the current state of the
repository and the desired one are different. This commit sets all the headers
to the desired state.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

5b1fb84

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

8a61ba9

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Sanitize the python headers Fix rucio#4980

c4b995c

The headers in this project are automatically generated. A script uses the git
history to determine the current header.

Since a lot of developers did not run the script, the current state of the
repository and the desired one are different. This commit sets all the headers
to the desired state.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

befbc30

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

622cb10

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

52a4fb9

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

cff5c26

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

cc08768

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

dd020c6

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

80bb9fe

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

8e106ef

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

c938f68

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

5ae6a50

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

f052639

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes linked a pull request

that will close this issue

Add header workflow integration 2 #5109

Merged

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

1bbfd32

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

d82e437

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

d5d41ee

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

e9d00ed

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

901f348

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

cb8f8cd

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

56f9d83

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

82ef072

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

8d3e6a0

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

f153b71

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

9c163a2

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Add a header check to the CI Fix rucio#4980

fc1c653

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Change the output of the add_header script Fix rucio#4980

c305e83

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

bari12 closed this as completed in #5109

bari12 pushed a commit that referenced this issue


          Add header workflow integration 2 (#5109)

eba868e

* Add a header check to the CI Fix #4980

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

* Change the output of the `add_header` script Fix #4980

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

bari12 pushed a commit that referenced this issue


          Add header workflow integration 2 (#5109)

a776021

* Add a header check to the CI Fix #4980

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

* Change the output of the `add_header` script Fix #4980

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

bari12 added this to the 1.23.18 milestone

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Fix the header-lint job rucio#4980

d1149cd

The `header-lint` job of the github actions reports "You have divergent
branches". This is a side effect of pulling the master branch into an already
checked-out repository. Since we have not specified the merge strategy, the job
fails.

We do not need to pull the master branch directly, since the `checkout` github
action automatically pulls the entire history for **all** branches. [1]

This commit removes the pull of the master branch, thus

[1] https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches

bari12 modified the milestones: 1.23.18, 1.27.4

piperov pushed a commit to piperov/rucio that referenced this issue


          Add header workflow integration 2 (rucio#5109)

502bed9

* Add a header check to the CI Fix rucio#4980

The `add_header` script needs to be run after an edit to determine the status of
the header and, if necessary, change the header.

This commit adds the check for the header to the CI/CD. This enforces the usage
of the `add_header` script and ensures a healthy code base.

* Change the output of the `add_header` script Fix rucio#4980

The `add_header` sript prints the correct header for a file if the `--in-place`
argument is not provided. This is a good way to see changes, however due to this
the output of the CI/CD is too verbose.

This commit disables the output of the output of the correct header, if the
`--check` option is provided. It also displays the number of files checked.

joeldierkes pushed a commit to joeldierkes/rucio that referenced this issue


          Run the add_header script on every PR and push except master rucio#4980

3a1a2ee

The `add_header` GitHub Acitons job is running on every pull request. While this
enforces the usage of the script, it most of the times creates a lot of noise,
since the developer has to change the PR after the test fails. We should have a
more intermediate feedback. Running the job on every push seems reasonable.

joeldierkes added a commit to joeldierkes/documentation that referenced this issue


          Add a description for the add-header script

c84eeb8

With the introduction of rucio/rucio#4980, the pyhton file headers get checked
on every PR. This means, that the `add-header` script has to be run on every
PR. This commit documents the usage of the `add-header` script.

joeldierkes added a commit to joeldierkes/documentation that referenced this issue


          Add a description for the add-header script

0ba8f03

With the introduction of rucio/rucio#4980, the pyhton file headers get checked
on every PR. This means, that the `add-header` script has to be run on every
PR. This commit documents the usage of the `add-header` script.

joeldierkes added a commit to joeldierkes/documentation that referenced this issue


          Add a description for the add-header script

9a1c48b

With the introduction of rucio/rucio#4980, the pyhton file headers get checked
on every PR. This means, that the `add-header` script has to be run on every
PR. This commit documents the usage of the `add-header` script.

joeldierkes mentioned this issue

Add a description for the add-header script rucio/documentation#89

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment