Skip to content
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

Update CONTRIBUTING and CHANGELOG #973

Closed
wants to merge 49 commits into from
Closed

Update CONTRIBUTING and CHANGELOG #973

wants to merge 49 commits into from

Conversation

bact
Copy link
Collaborator

@bact bact commented Jun 13, 2024 •
edited

Some of the contents refer to v2.3, so it needs an update.

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)

Change log:

  • Add release dates for 3.0 (2024-04-15) and 2.3 (2022-11-03)
    • Other releases already have the date, except those two
  • Add SPDX specification 3.0 release announcement link on Linux Foundation website

(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)

goneall
goneall approved these changes Jun 14, 2024
View reviewed changes
Copy link
Member

@goneall goneall left a 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.

@bact
Copy link
Collaborator Author

bact commented Jun 15, 2024 •
edited

@goneall noted.

Btw, since we only have a change log file in the spdx-spec repo (and not in the spdx-3-model repo),
should I also include the link to the release notes of the model as well in this CHANGELOG.md?

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?

@goneall
Copy link
Member

goneall commented Jun 16, 2024

@goneall noted.

Btw, since we only have a change log file in the spdx-spec repo (and not in the spdx-3-model repo), should I also include the link to the release notes of the model as well in this CHANGELOG.md?

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.

@bact
Copy link
Collaborator Author

bact commented Jun 16, 2024

A link to model release notes added.

@bact
Copy link
Collaborator Author

bact commented Jun 29, 2024

A change log for spdx-3-model repo is now available at
https://github.com/spdx/spdx-3-model/blob/main/CHANGELOG.md

@goneall goneall added this to the 3.0.1 milestone Jul 22, 2024
@bact bact force-pushed the update-contributing-guideline branch from fad47ec to e8d2a78 Compare August 1, 2024 14:14
bact and others added 23 commits August 1, 2024 15:14
@bact
Update CONTRIBUTING and CHANGELOG
ce06a94 
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>
@bact
Add release notes for the model
27b7f5b 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@zvr @bact
Adds a new annex on license matching
66518b3 
Signed-off-by: Alexios Zavras <github@zvr.gr>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@zvr @bact
Adds pkg-url spec as an annex
21ab84e 
Signed-off-by: Alexios Zavras <github@zvr.gr>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Update publish_v3.yml to alias "v3.0" as "latest"
53390de 
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>
@bact
Set mike canonical_version
fd46502 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Update CI to build from and generate 3.0.1
bac7569 
Co-authored-by: Jeff Licquia <jeff@licquia.org>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact @zvr
Update .github/workflows/publish_v3.yml
ab559d9 
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>
@bact @zvr
Use 3.0.1 for now
d3a5134 
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>
@vargenau @bact
Fix Philippe Ombredanne name
23beb27 
Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
[3.0] Use H2 for headings in Annex A to fix nav bar issue
4e9db4b 
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>
@bact
Put together text portions from the same bullet
19cbbbb 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@NorioKobota @bact
Fix cardinality to conform to the full SPDX specification due to type…
9a1e1dd 
… checking problems in spdx-samples.

Signed-off-by: Norio Kobota <norio.kobota@sony.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@NorioKobota @bact
specVersion should be Semver.
690a79a 
Signed-off-by: Norio Kobota <norio.kobota@sony.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@NorioKobota @bact
Revise comments to make it a little clearer.
11d78df 
Signed-off-by: Norio Kobota <norio.kobota@sony.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@vargenau @bact
Add clarification for case-sensitivity for LicenseRef-
dbd74b7 
Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@vargenau @zvr @bact
Update docs/annexes/SPDX-license-expressions.md
04bdc49 
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>
@bact
Set 3.0.1 as draft at this dev moment
31a90d0 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Add comment on stable release
15f2173 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Add comment for canonical_version
c4aa2f1 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Reorder arguments
644fcb2 
Make the argument orders the same order as in "mike deploy -h" for easy ref.

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Mark the v3.0.1 DRAFT at copyright line
af910c0 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Add site description
047e971 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact added 17 commits August 1, 2024 15:14
@bact
Use mkdocs-files.yml for model list
d7142e3 
- 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>
@bact
Update PR validation to use mkdocs-files.yml
af7ab89 
Update PR validation workflow to use mkdocs-files.yml

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Make redirection work for default Ubuntu shell
484c294 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Remove trailing space in sed -e expression
2a9170f 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Use one-line sed
23b150a 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Use | for sed delimiter instead of /
f4e5bf0 
To avoid confusion with file path inside -e expression

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Use | delimiter in sed
5f1118f 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Use one-line sed with | delimiter
aa8c322 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Remove unnecessary temp file
b7bd370 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Make sed multiple lines
5a81b82 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Insert new line after mkdocs-files.yml
13efc9e 
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>
@bact
Add blank line between insert and delete expression in sed
39325e2 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Add mkdocs validation and draft_docs
a60d492 
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>
@bact
Use enabled_if_env to switch pdf-export
478d989 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Add 3.0 release announcement link on Linux Foundation website
ff127ca 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Add link to spdx/meetings
e8d2a78 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Merge branch 'spdx:development/v3.0.1' into update-contributing-guide…
b9e4a50 
…line
@zvr zvr removed this from the 3.0.1 milestone Aug 4, 2024
kestewart
kestewart approved these changes Aug 9, 2024
View reviewed changes
Copy link
Contributor

@kestewart kestewart left a 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.

@goneall goneall added this to the 3.0.1 milestone Aug 9, 2024
@goneall
Copy link
Member

goneall commented Aug 9, 2024

@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.

@bact
Copy link
Collaborator Author

bact commented Aug 9, 2024

@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.

@bact
Copy link
Collaborator Author

bact commented Aug 9, 2024

@goneall I will better open new PR and ping you in 2 mins.

@bact bact mentioned this pull request Aug 9, 2024
Merged
@bact
Copy link
Collaborator Author

bact commented Aug 9, 2024

@goneall I copy two files to this PR #1031, please use that one instead. sorry for inconvenience. Will close this.

@bact bact closed this Aug 9, 2024
@bact bact deleted the update-contributing-guideline branch August 9, 2024 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@goneall goneall goneall approved these changes

@kestewart kestewart kestewart approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
3.0.1
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@bact @goneall @kestewart @zvr @vargenau @NorioKobota