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

Publish 3.0.1 as v3.0.1-draft #995

Merged
merged 28 commits into from
Jul 30, 2024
Merged

Publish 3.0.1 as v3.0.1-draft #995

merged 28 commits into from
Jul 30, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 18, 2024 •
edited
Loading

What this PR do?

Loosely applying steps 5, 7, and 8 in #950 (comment) but using v3.0.1-draft as a version for now while 3.0.1 is still in development.

  • in .github/workflows/publish_v3.yml:

    • Publish v3.0.1-draft, using development/v3.0.1 of spdx-spec and main of spdx-model
    • Update actions/checkout to v4 to prevent build warning of Node.js deprecation

  • Use the generated mkdocs-files.yml from Use the actual list of model entries #978

Notes

After v3.0.1 is released, another PR can be made to publish v3.0.1, using development/v3.0.1 of spdx-spec and 3.0.1 of spdx-model -- also assign the version v3.0.1 with two aliases v3.0.1-draft and latest.

  • run: mike deploy -u -b gh-pages -p v3.0.1 v3.0.1-draft latest

bact added 8 commits July 18, 2024 08:14
@bact
Set 3.0.1 as draft at this dev moment
c01f54d 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add comment on stable release
31df49a 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add comment for canonical_version
d217620 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Reorder arguments
5d6a925 
Make the argument orders the same order as in "mike deploy -h" for easy ref.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Mark the v3.0.1 DRAFT at copyright line
6784d07 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add site description
f16ecee 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add comment on 3.0.1 checkout
ca34ed8 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add DRAFT mark
ab5376d 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
This was referenced Jul 18, 2024
Merged
Closed
@bact bact mentioned this pull request Jul 23, 2024
Closed
zvr
zvr requested changes Jul 24, 2024
View reviewed changes
@bact @zvr
Update mkdocs.yml
b40dfef 
Co-authored-by: Alexios Zavras (zvr) <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Jul 24, 2024 •
edited
Loading

The new version of the spec-parser will generate as well mkdocs-files.yml which contains a list of model files.

mkdocs.yml has to be modified to use that:

  • The model subsection under nav has to be modified to an empty list.
  • After the spec-parser run, copy the content from mkdocs-files.yml and put it in the model subsection.

See #978

@goneall
Copy link
Member

goneall commented Jul 24, 2024

@puerco - Should we use commits for the actions rather than tags?

@bact
Copy link
Collaborator Author

bact commented Jul 24, 2024

Can change to

uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7

@goneall
Copy link
Member

goneall commented Jul 25, 2024

Can change to

uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  #v4.1.7

Thanks @bact - this should resolve the possible security issue if the tag is changed.

bact added 10 commits July 25, 2024 03:25
@bact
checkout commit instead of checkout tag
326dab2 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Upgrade to mkdocs 1.6 to fix nav issue
ecb432d 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use mkdocs-files.yml for model list
76c597a 
- 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 <[email protected]>
@bact
Update PR validation to use mkdocs-files.yml
fa6ad0a 
Update PR validation workflow to use mkdocs-files.yml

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Make redirection work for default Ubuntu shell
cf1e7ea 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Remove trailing space in sed -e expression
8dda7f3 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use one-line sed
39b9d24 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use | for sed delimiter instead of /
f21afa4 
To avoid confusion with file path inside -e expression

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use | delimiter in sed
bb8701e 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use one-line sed with | delimiter
c31bd9a 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
bact added 6 commits July 25, 2024 18:44
@bact
Remove unnecessary temp file
ac3655d 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Make sed multiple lines
3b20815 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Insert new line after mkdocs-files.yml
8096542 
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 <[email protected]>
@bact
Add blank line between insert and delete expression in sed
fe4f757 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add mkdocs validation and draft_docs
6022530 
Add mkdocs files and links validation

Files need to be somewhere, if not in nav, then in draft_docs.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use enabled_if_env to switch pdf-export
9dfb3b3 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Jul 26, 2024

@zvr publish_v3.yml publication workflow is now using the actual list of model entries generated by spec-parser. See lines 56-69.

Note that I have modify the PR validation workflow validate_pull_request.yml to do the same (using the generated list of model entries). This is necessary to have this PR pass all the checks.

@zvr
Copy link
Member

zvr commented Jul 26, 2024 •
edited
Loading

I think the default shown should be the one we're working on, but this can be decided and changed later.
Waiting for another approval to push and deploy this.

@bact
Copy link
Collaborator Author

bact commented Jul 26, 2024

Agree. Let's have this published first and we can start seeing updated contents and formats. Then made any necessary changes afterwards.

@bact bact mentioned this pull request Jul 29, 2024
Closed
goneall
goneall approved these changes Jul 30, 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

@goneall goneall merged commit 048daca into spdx:development/v3.0.1 Jul 30, 2024
3 checks passed
@bact
Copy link
Collaborator Author

bact commented Jul 30, 2024

Thank you. Content from development/v3.0.1 is now published at https://spdx.github.io/spdx-spec/v3.0.1-draft/

This was referenced Jul 30, 2024
Closed
Closed
Closed
@bact bact deleted the publish-3.0.1-as-draft branch July 30, 2024 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zvr zvr zvr approved these changes

@goneall goneall goneall approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@bact @goneall @zvr