Skip to content

fix: add missing vars step and remove redundant -a flag in deploy job#1403

Open
Devansh-567 wants to merge 1 commit into
p4lang:mainfrom
Devansh-567:fix/asciidoc-vars-step
Open

fix: add missing vars step and remove redundant -a flag in deploy job#1403
Devansh-567 wants to merge 1 commit into
p4lang:mainfrom
Devansh-567:fix/asciidoc-vars-step

Conversation

@Devansh-567

Copy link
Copy Markdown
Contributor

The deploy job referenced steps.vars.outputs.sha_short but had no step with id: vars defined, causing every deploy commit message to read "docs for " with an empty SHA

Also removed the -a flag from git commit since all files are
already explicitly staged by the preceding git add.

… workflow

Signed-off-by: Devansh-567 <devansh.jay.singh@gmail.com>
@jafingerhut

Copy link
Copy Markdown
Collaborator

I know this isn't something that you commented on or attempted to change, but one thing that I believe is true about the release scripts in this repository is that on every change to the specification source code, the new versions of generated PDF and HTML files are added to the repository history, causing the size of the .git directory to grow fairly quickly across many versions. The p4runtime repository I believe does something different so that only the most recent version of generated PDF and HTML files are stored in the .git files. If you could determine what the difference is there, and modify the p4-spec repo scripts to do the same, it would help eliminate that fairly rapid increase in p4-spec repo size over time.

@Devansh-567

Copy link
Copy Markdown
Contributor Author

I looked at the p4runtime repository's main-branch-uploads.yml. The key difference is that it uses EndBug/add-and-commit@v9 with commit: '--amend' and push: 'origin gh-pages --force', which amends the previous commit on gh-pages rather than adding a new one on every deploy. This keeps the gh-pages branch at a single commit permanently, preventing unbounded git history growth. I can implement the same approach in p4-spec's deploy job if that would be helpful.

@jafingerhut

Copy link
Copy Markdown
Collaborator

I can implement the same approach in p4-spec's deploy job if that would be helpful.

That would be wonderful! If you are willing, please do so.

@Devansh-567

Devansh-567 commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

Hi @jafingerhut, just checking in on this PR. The gh-pages optimization discussed here has since been implemented in #1408. Whenever you get a chance, I'd appreciate a review. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants