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

Automatic deployment of asciidoc manual to GitHub releases. #44

Open
jenskeiner opened this issue Aug 16, 2017 · 2 comments
Open

Automatic deployment of asciidoc manual to GitHub releases. #44

jenskeiner opened this issue Aug 16, 2017 · 2 comments
Assignees
Labels
automation Suggestions and possible candidates for automation. build routine Topics concerning the build routine. documentation Topics concerning the documentation. enhancement
Milestone

Comments

@jenskeiner
Copy link
Contributor

The current TravisCI set up is such that when building from a tag, it will upload the complete source package to create a release on GitHub. In addition, documentation assets, preferably the previously added asciidoc manual, should be uploaded as well.

@jenskeiner jenskeiner added this to the 3.4.1 milestone Aug 16, 2017
@jenskeiner jenskeiner self-assigned this Aug 16, 2017
@tvolkmer tvolkmer modified the milestones: 3.4.1, 3.4.2 Mar 26, 2018
@michaelquellmalz michaelquellmalz modified the milestones: 3.5.1, 4.0.0 Mar 5, 2019
@kevinmatthes
Copy link
Contributor

As far as I can see, this would just require further build instructions.

We could instruct the CI to execute a certain build command which not only depends on the library (source package) but also on the according documentation(s) to be zipped into the release package, as well.

@kevinmatthes kevinmatthes added automation Suggestions and possible candidates for automation. build routine Topics concerning the build routine. labels Oct 30, 2021
@kevinmatthes
Copy link
Contributor

How about automatically uploading the documentation in a pre-compiled / self-compiling form into a separate repository within the NFFT namespace? Or into the wiki section of this repository?

For instance, the separate repository could hold this one as a submodule with the CI instructions to automatically render the hole documentation. We would just need to

  • set up the separate repository.
  • instruct it with the documentation creation as CI operation.
  • link the separate repository in README.md for reference ("Users who seek the documentation may find it there.").
  • update the separate repository once per release for assuring the latest version of the documentation(s). Maybe this can be done as well by the CI instructions, I am not that familiar with it, yet.

@kevinmatthes kevinmatthes added the documentation Topics concerning the documentation. label Oct 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Suggestions and possible candidates for automation. build routine Topics concerning the build routine. documentation Topics concerning the documentation. enhancement
Projects
None yet
Development

No branches or pull requests

4 participants