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 additional action to publish docs of main #23

Open
1 task
sascha-wolf opened this issue Mar 26, 2021 · 3 comments · May be fixed by #27
Open
1 task

Add additional action to publish docs of main #23

sascha-wolf opened this issue Mar 26, 2021 · 3 comments · May be fixed by #27
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@sascha-wolf
Copy link
Collaborator

Currently docs only get published on release.

It would be great if we could publish the docs for main on each push/merge.

Questions

  • Which version would these docs have?
@sascha-wolf sascha-wolf added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Mar 26, 2021
@joseemds
Copy link

Hi, i would like to try this one, about the version name. what about: next or x.y.z-dev?

@sascha-wolf
Copy link
Collaborator Author

Hey @joseemds thanks for considering to pick this up.

The version needs to follow the constraints laid out in the docs of the Version module which follow the ones from semver.org.

Without going into details: this makes next an impossible option although I do think it'd be a good choice.

The best next option I can see would be <next version>-dev which right now (with the current version being 1.4.1) would be 1.4.2-dev. That would require the following steps:

  1. figure out the current version (should be possible through git describe --first-parent --tags --abbrev=0 which returns v1.4.1 right now on main)
  2. figure out the next semver version (maybe there's a GitHub Action we can use here?)
  3. write the calculated version to the version file and publish to Hex (check the release action for details on this)

Does this make sense and give you enough pointers to figure things out, @joseemds?

@joseemds
Copy link

Hi @sascha-wolf, yes it does, thanks for the guidance

@joseemds joseemds linked a pull request Oct 20, 2021 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants