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

[3.0.1] [Publication] Fix failed CI, fix canonical URL, set aliases #1015

Closed
wants to merge 37 commits into from
Closed

[3.0.1] [Publication] Fix failed CI, fix canonical URL, set aliases #1015

wants to merge 37 commits into from

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 31, 2024 •
edited
Loading

Closed - use #1093 instead

3.0.1 Publication - This will fix #1034 too

Aliases and default

  • Run mike delete commands to remove an existing version deployment with the same name as the alias, before making aliases (mike does not allow the alias to overtake the name of existing version deployment, so we have to delete them first)
  • Remove mike set-default for this draft version (to fix the failed build), will set-default to v3.0.1 once v3.0.1 is released
  • Set aliases according to the proposal in Spec website: How do we like the URL aliases to work? #1018

Update chapter list

  • Update chapter "Normative references" to "References"
  • Add chapter "Symbols"

Canonical URL

  • Fix canonical URL (site_url must be to root of the site, without the version, it will be combined with the version to become the canonical URL)

Test quicker

  • Update mkdocs.yml to make it usable even without model files
  • Also make validation process (of the spec docs alone) quicker
    • No need to pull the entire spdx-3-model repo and generate model files (just like in earlier version) when it's not necessary
  • Less moving parts from spdx-3-model repo (things can break in the model, but changes in chapters/annexes in the spec can still be validated).
  • This re-enables ability to test the website immediately with only content from spdx-spec repo

Others

  • Update .gitignore to exclude temp files, like docs/model/ and __mkdocs-full.yml, generated during build
  • Update README to match the latest workflow

This PR is a step before making v3.0.1 a default version.
(This PR currently set default version to v3.0.1-draft, have to update it to v3.0.1 afterward)

bact added 12 commits July 31, 2024 07:59
@bact
Run mike default in deploy environment
955564d 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Exclude dirs created during build
134f9d6 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update .gitignore and README to match
7c5345e 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Push the set-default
e6a6301 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Validate with only what necessary
608f5b5 
This is also to reduce the moving parts that will make the PR fails

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Notes on regeneration of mkdocs config
b2b4835 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add note on ontology copy
f0c3d32 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Use __MODEL_PLACEHOLDER__
eb0eb44 
[ ] can be seen as part of regex symbols

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update 3.0.1 link in README
6e3ed0f 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update annex titles in mkdocs.yml to match titles in files
9f8a2c4 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update dependencies
091d0d5 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Set site_url to root
9b2a262 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact mentioned this pull request Aug 3, 2024
Closed
@bact
Use redirect for alias
a7100bd 
So the URL in the browser changes

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact mentioned this pull request Aug 3, 2024
Closed
@bact bact changed the title Set default to v3.0.1-draft [Workflow] Validate PR without spdx-3-model dependency; Update build README to match Aug 5, 2024
@bact bact changed the title [Workflow] Validate PR without spdx-3-model dependency; Update build README to match [Workflow] Fix canonical URL; Validate PR without spdx-3-model dependency Aug 6, 2024
@bact
Set canonical URL to v3.0.1 one
e7cc825 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update mkdocs.yml
e40c4bd 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Set sticky_navigation to true
2381397 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Merge branch 'spdx:development/v3.0.1' into set-default-to-301
a994d57
@bact
Merge branch 'development/v3.0.1' into set-default-to-301
7b7fbfa
@bact
Minimize changesete
7e821e9 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
README: v3.0.1-draft -> v3.0.1
68b38d5 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
v3.0.1 -> v3.0.1-draft
5361abc 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Update copyright line with OMG contributors
518e2fa 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@goneall goneall added this to the release-independent milestone Aug 9, 2024
@kestewart kestewart requested a review from goneall August 9, 2024 18:50
@kestewart kestewart requested a review from zvr August 9, 2024 18:50
@bact
Merge branch 'development/v3.0.1' into set-default-to-301
ae1d725
@bact
Add chapters
5ae0eb0 
Update References chapter
Add Symbols chapter

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact changed the title [Workflow] Fix canonical URL; Validate PR without spdx-3-model dependency [3.0.1] [Workflow] Add new Chapters in mkdocs.yml, fix canonical URL Aug 9, 2024
@bact bact mentioned this pull request Aug 10, 2024
Closed
@bact bact changed the title [3.0.1] [Workflow] Add new Chapters in mkdocs.yml, fix canonical URL [3.0.1] [Publication] Fix failed CI, fix canonical URL, set aliases Aug 10, 2024
@bact
Put "The" to "The Linux Foundation"
66c5103 
Per spdx#1010 (comment)

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Add missing fullstops
1467b90 
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@goneall
Copy link
Member

goneall commented Aug 10, 2024

@licquia @zvr - Could you do a review of these changes?

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

bact commented Aug 11, 2024 •
edited
Loading

I will create new PRs to replace this one

  • Some of the issues addressed here are already fixed elsewhere
  • Make each PR smaller
    • One to update publish and validation workflows, to set default to 3.0.1
    • Another to update README to reflect the new flows

@bact
Copy link
Collaborator Author

bact commented Aug 27, 2024

Closed - use #1093 instead

@bact bact closed this Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@goneall goneall Awaiting requested review from goneall

@zvr zvr Awaiting requested review from zvr

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
release-independent
Development

Successfully merging this pull request may close these issues.

CI failing after recent merges
2 participants
@bact @goneall