-
Notifications
You must be signed in to change notification settings - Fork 135
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
Update CONTRIBUTING and CHANGELOG #973
Conversation
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.
LGTM - Thanks @bact
BTW We'll need to update this again when we change the branch structure for the repo.
@goneall noted. Btw, since we only have a change log file in the spdx-spec repo (and not in the spdx-3-model repo), From this: "See the v3.0 GitHub release notes for changes." To something like this: "See the v3.0 GitHub release notes for changes in the spec and in the model." Or does there other recommended way to have in one place informing the reader about changes in v3.0? |
Very good point - I think we should point to both changelogs for completeness. |
A link to model release notes added. |
A change log for spdx-3-model repo is now available at |
fad47ec
to
e8d2a78
Compare
Change log: - Add release dates for 3.0 (2024-04-15) and 2.3 (2022-11-03) Contributing guideline: - Add info about sign off - Update branch names - Minor change to `development/v3.0.1` branch - Major change to `development/v3.1` branch (this may be not accurate, need comments) Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Alexios Zavras <github@zvr.gr> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Alexios Zavras <github@zvr.gr> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Update `alias` argument for `mike deploy` to have `v3.0` as the `latest` `v3.0` was aliased as `v3-draft`, so `v2.3` still keep the `latest` alias. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Co-authored-by: Jeff Licquia <jeff@licquia.org> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com> Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com> Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Replace H1 with H2 headings, to allow mkdocs/readthedocs to generate proper heading items in navigation bar. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
… checking problems in spdx-samples. Signed-off-by: Norio Kobota <norio.kobota@sony.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Norio Kobota <norio.kobota@sony.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Norio Kobota <norio.kobota@sony.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr> Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Make the argument orders the same order as in "mike deploy -h" for easy ref. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
- Remove model file list from mkdocs.yml - Generate mkdocs-final.yml from base mkdocs.yml and mkdocs-files.yml - Let mike deploy using mkdocs-final.yml Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Update PR validation workflow to use mkdocs-files.yml Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
To avoid confusion with file path inside -e expression Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Regardless if mkdocs-files.yml has a standard one blank line at the end of file or not, we insert one, just in case. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Add mkdocs files and links validation Files need to be somewhere, if not in nav, then in draft_docs. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
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.
Thanks. Changes for better rendering look good.
@bact - sorry to bother you about one more merge conflict resolution. Since @kestewart has now reviewed, I can merge as soon as the conflicts are resolved. |
@goneall I will check it now. But so far I can't see the conflicts. There're only two files here and I don't think we change these changelog and contributing anywhere else. Possible that it is due to my force commit few days ago when I forgot to sign-off. |
@goneall I will better open new PR and ping you in 2 mins. |
Some of the contents refer to v2.3, so it needs an update.
Contributing guideline:
development/v3.0.1
branchdevelopment/v3.1
branch (this may be not accurate, need comments)Change log:
(Please squash merge this PR. I had forgot to sign-off one of the commits and when fixing that it includes a bunch of commits with it. The number of files changed remains the same: 2)