docs: use information from the previous release to create pages #4457
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ldez
added
enhancement
ldez
changed the title
ldez
changed the title
alexandear
reviewed
Mar 5, 2024
ldez
force-pushed
the
fix/early-documentaion
branch
2 times, most recently
from
0a4585f
to
ff46b7d
Compare
bombsimon
approved these changes
Mar 6, 2024
There was a problem hiding this comment.
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!
ldez
force-pushed
the
fix/early-documentaion
branch
from
416b82a
to
841cb1a
Compare
yes exactly |
ldez
force-pushed
the
fix/early-documentaion
branch
3 times, most recently
from
2dc2134
to
4189280
Compare
- one for the reference of the released version - one for the next release
ldez
force-pushed
the
fix/early-documentaion
branch
from
4189280
to
adff736
Compare
Antonboom
reviewed
Mar 13, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
use 2 references files:
.golangci.reference.yml).golangci.next.reference.yml)I restored
.golangci.reference.ymlfrom v1.56.2 tag..golangci.next.reference.ymlcontains the new elements related to the next release.I also added a workflow to update automatically
.golangci.reference.ymlwith.golangci.next.reference.ymlafter a release.The update will be done automatically in the same generated PR that updates the GitHub Action assets.
The target
expand_website_templateshas been renamed towebsite_expand_templates.Previously, the target
expand_website_templateswas using calls to theManagerand output from help commands.Now the target
website_expand_templatesuses the files generated from another targetwebsite_dump_info.website_dump_infouses calls to theManagerand 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.ymlis 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.jsonshould also be updated by hand.Related to #4450
Related to #4255