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

add version info #21

Merged
merged 1 commit into from
May 15, 2024
Merged

Conversation

Seasawher
Copy link
Contributor

@Seasawher Seasawher commented May 14, 2024

missing version info causes an error

@kim-em
Copy link
Collaborator

kim-em commented May 15, 2024

We might think about how we're going to keep this in sync. I guess just whoever makes releases is going to have to grep for this each time? Perhaps stick this in RELEASES.md?

@oliver-butterley
Copy link
Contributor

oliver-butterley commented May 15, 2024

I'm assuming that:

  • Releases will be gh releases of the form v1.0.0, etc
  • Within a major version the inputs and general behaviour will remain compatible
  • For each major release there will be a tag, e.g., v1 which points to the latest release of the form v1..
  • In the readme we suggest the use case referencing the major version, i.e., leanprover/lean-action@v1

I propose:

  • Add a script like the one used by official actions to generate the major version tags correctly on each minor release
  • I second @semorrison suggestion to add the note about updating the readme as a reminder since I don't see a simple way to automate the update of the readme

@austinletson
Copy link
Collaborator

We might think about how we're going to keep this in sync. I guess just whoever makes releases is going to have to grep for this each time? Perhaps stick this in RELEASES.md?

I'm assuming that:

  • Releases will be gh releases of the form v1.0.0, etc
  • Within a major version the inputs and general behaviour will remain compatible
  • For each major release there will be a tag, e.g., v1 which points to the latest release of the form v1..
  • In the readme we suggest the use case referencing the major version, i.e., leanprover/lean-action@v1

I think these assumptions are right. Created #23 to add documentation for this. We could definitely improve and add more details.

I propose:

  • Add a script like the one used by official actions to generate the major version tags correctly on each minor release
  • I second @semorrison suggestion to add the note about updating the readme as a reminder since I don't see a simple way to automate the update of the readme

@oliver-butterley It would be awesome to automate this! Do you have a recommendation for an action which would do this automatically? It seems like GitHub discourages developers from using the publish-action used in the linked example.

@austinletson austinletson merged commit 0f24b05 into leanprover:main May 15, 2024
1 check passed
@austinletson
Copy link
Collaborator

Thank you @Seasawher!

@Seasawher Seasawher deleted the Seasawher-patch-1 branch June 15, 2024 19:09
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.

4 participants