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.

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

Autogenerated and check in examples/index.html #1079

Closed
spectranaut opened this issue Jul 12, 2019 · 6 comments · Fixed by #1524
Closed

Autogenerated and check in examples/index.html #1079

spectranaut opened this issue Jul 12, 2019 · 6 comments · Fixed by #1524
Assignees
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation
Milestone

Comments

@spectranaut
Copy link
Contributor

When merging into master, we should auto-generate and check examples/index.html into master. Can this happen in the travis deploy script?

@spectranaut
Copy link
Contributor Author

@nschonni my impression is that this should be easy to add to the deploy, but looking at the /scripts/travis-before_deploy.sh and scripts/travis-deploy.sh I'm not sure how to fit it. Maybe another script that runs before the before. I'm also curious if committing into master will cause trigger travis to run again. Do you know how to do this easily? Otherwise I'll dig into it more!

@nschonni
Copy link
Contributor

nschonni commented Jul 12, 2019

You might be able to commit with a [skip ci] or [ci skip] in the commit message body to avoid a recursive build

@nschonni
Copy link
Contributor

Another thought would be to skip checking the generated file into master at all, and just generate it for the gh-pages branch.

@spectranaut spectranaut self-assigned this Nov 5, 2019
@mcking65
Copy link
Contributor

One reason why I want it in master is because it then feeds our other publication branches, e.g., we merge from master into apg-1.2, and later apg-1.3. However, since we don't do that often, I guess that can be manual as I just did for the working draft prep.

If it is a much smaller and simpler ask, perhaps just generate automatically for the gh-pages branch.

@mcking65 mcking65 added the Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation label Nov 16, 2019
@nschonni
Copy link
Contributor

@mcking65 were you wanting it so you'd get a diff when merging other branches?

zcorpan added a commit that referenced this issue Apr 3, 2020
…t is run

The command to regenerate is: npm run build

The new lint command is: npm run lint:build

Document this in the README. Run the new lint in Travis CI to ensure that
PRs that change something under examples/ also regenerate the index.

Fixes #1079.
@zcorpan
Copy link
Member

zcorpan commented Apr 3, 2020

I would prefer one of the following:

  • The examples/index.html file is not checked in at all, but is only generated for publication.
  • The examples/index.html file is checked in, and there is some enforcement to regenerate it.

The other approaches discussed above seem like they could result in things getting out of sync or otherwise be hard to follow what's going on, in my opinion.

Since @mcking65 said he wanted the file checked in to master, I've implemented the enforcement option in #1365.

mcking65 added a commit that referenced this issue Dec 14, 2020
… would change it (pull #1524)

Resolves #1079:
* chore: GitHub Action to check examples index.html
* fix: sync examples/index.html
* chore: run lint-staged for reference-table files

Co-authored-by: Matt King <[email protected]>
@mcking65 mcking65 added the enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy label Dec 14, 2020
@mcking65 mcking65 added this to the 1.2 Release 1 milestone Dec 14, 2020
mcking65 added a commit that referenced this issue Dec 14, 2020
… would change it (pull #1524)

Resolves #1079:
* chore: GitHub Action to check examples index.html
* fix: sync examples/index.html
* chore: run lint-staged for reference-table files

Co-authored-by: Matt King <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any addition or improvement that doesn't fix a code bug or prose inaccuracy Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation
Projects
None yet
4 participants