-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: use information from the previous release to create pages #4457
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.
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
Conversation
0a4585f
to
ff46b7d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hope I didn't miss anything but this seems to simply be a split of the old code in a single main.go
file to several files and the big diff (additions) is due to the copy of the reference and the new JSON files?
If so, feel free to ignore my comments about any code, this LGTM. Nice with a file that targets the latest release separately!
416b82a
to
841cb1a
Compare
yes exactly |
2dc2134
to
4189280
Compare
- one for the reference of the released version - one for the next release
4189280
to
adff736
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a lot of code 💥
thank you for your job!
use 2 references files:
.golangci.reference.yml
).golangci.next.reference.yml
)I restored
.golangci.reference.yml
from v1.56.2 tag..golangci.next.reference.yml
contains the new elements related to the next release.I also added a workflow to update automatically
.golangci.reference.yml
with.golangci.next.reference.yml
after a release.The update will be done automatically in the same generated PR that updates the GitHub Action assets.
The target
expand_website_templates
has been renamed towebsite_expand_templates
.Previously, the target
expand_website_templates
was using calls to theManager
and output from help commands.Now the target
website_expand_templates
uses the files generated from another targetwebsite_dump_info
.website_dump_info
uses calls to theManager
and output from help commands to create JSON files.The update will be done automatically in the same generated PR that updates the GitHub Action assets.
The file
.golangci.reference.yml
is used to generate the documentation (configuration and linters pages).Then the documentation about new options will not be published before a release.
If we need to fix something in the current doc, we should update the file
.golangci.reference.yml
.If we need to add new options or linters, we should update the file
.golangci.next.reference.yml
.If there are fixes to linters information, the generated file
assets/linters-info.json
should also be updated by hand.Related to #4450
Related to #4255