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

Adds GH pages workflow and minor updates #48

Merged
merged 16 commits into from
Dec 5, 2023

Conversation

johnedquinn
Copy link
Member

@johnedquinn johnedquinn commented Nov 27, 2023

Relevant Issues

Motivation

The PartiQL Maintainers expressed the desire to make it easier to update the specification and have more tangible impact. As a mechanism for tackling these issues, I wanted to allow the tip-of-head specification to always be rendered.

Description

  • This PR adds a GH Pages Workflow.
    • The head fork has GH Pages set up already. See the live site here.
    • On pushes to main, this will build using docker and place the HTML in the gh-pages branch.
  • This PR also makes a few small changes:
    • We set versions explicitly to ensure that our builds are reproducible -- especially considering the fact that we don't maintain the Gemfile.lock. I ran into build issues because of this.
    • I modified how we perform releases. This matches how we perform releases for other projects such as PLK.
    • I removed the -it flag for running docker interactively -- this is because GH Actions doesn't allow this.
    • I updated how we retrieve the date of publication. I now do it by the last git commit date -- this ensures that when we checkout a tag, we can run it, and it gives us consistent dates.
    • I also updated the section links/anchors. See the documentation here. Now, we can send links to sections easily to each other.

Moving Forward

We will want to update how we perform releases. In my opinion, we need to update the revision numbers, tag, build on the tag, attach the generated HTML/PDF to the release assets, and update the development version.

Other Notes

  • If approved, do NOT merge this for me. I need to enable GH Pages and create a dedicated branch before this workflow runs. I haven't done it yet as I wanted the maintainers' feedback before modifying the repository.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@johnedquinn johnedquinn marked this pull request as ready for review November 27, 2023 18:03
@@ -2,9 +2,13 @@
The PartiQL Specification Committee
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it too involved to add a link to the latest released version (as adoc) at the top? if yes, maybe we can add a link to the list of all releases?

https://github.com/partiql/partiql-lang/releases

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, and thank you for porting the previous releases!

@@ -2,9 +2,13 @@
The PartiQL Specification Committee
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, and thank you for porting the previous releases!

@johnedquinn johnedquinn merged commit e1e00cb into partiql:main Dec 5, 2023
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.

3 participants