Mentions légales du service
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Chameleon
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Operate
Environments
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
solverstack
Chameleon
Commits
be88374a
Commit
be88374a
authored
8 years ago
by
PRUVOST Florent
Browse files
Options
Downloads
Patches
Plain Diff
add info for publishing the release tarball on github
parent
42bb7030
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README-dev.org
+18
-5
18 additions, 5 deletions
README-dev.org
with
18 additions
and
5 deletions
README-dev.org
+
18
−
5
View file @
be88374a
...
@@ -26,10 +26,10 @@ developers must follow and that should be read by contributors.
...
@@ -26,10 +26,10 @@ developers must follow and that should be read by contributors.
#+end_src
#+end_src
* Documentation
* Documentation
<<sec:doc>>
** Generate the documentation
** Generate the documentation
***
Prerequisites
*** Prerequisites
To generate the documentation you need to have [[http://www.stack.nl/~dimitri/doxygen/][Doxygen]] and
To generate the documentation you need to have [[http://www.stack.nl/~dimitri/doxygen/][Doxygen]] and
[[https://www.gnu.org/software/texinfo/][Texinfo]] installed on your system.
[[https://www.gnu.org/software/texinfo/][Texinfo]] installed on your system.
...
@@ -66,7 +66,8 @@ developers must follow and that should be read by contributors.
...
@@ -66,7 +66,8 @@ developers must follow and that should be read by contributors.
chameleon-major.minor.patch.tar.gz, which:
chameleon-major.minor.patch.tar.gz, which:
1) has been properly tested,
1) has been properly tested,
2) contains a generated documentation corresponding to the released version,
2) contains a generated documentation corresponding to the released version,
3) is published on internet.
3) has an up-to-date ChangeLog file,
4) is published on internet.
** Test Chameleon before packaging
** Test Chameleon before packaging
...
@@ -77,13 +78,25 @@ developers must follow and that should be read by contributors.
...
@@ -77,13 +78,25 @@ developers must follow and that should be read by contributors.
** Source tarball generation
** Source tarball generation
This step requires to generate the [[sec:doc][documentation]].
#+begin_src sh
#+begin_src sh
export CHAMELEON_ROOT=/path/to/chameleon/sources/to/be/released
export CHAMELEON_ROOT=/path/to/chameleon/sources/to/be/released
cmake $CHAMELEON_ROOT -DCHAMELEON_ENABLE_DOCS=ON
cmake $CHAMELEON_ROOT -DCHAMELEON_ENABLE_DOCS=ON
make docs && cp docs/texinfo/users_guide.pdf $CHAMELEON_ROOT && make package_source
make docs && cp docs/texinfo/users_guide.pdf $CHAMELEON_ROOT && make package_source
#+end_src
#+end_src
A tarball chameleon-major.minor.patch.tar.gz should be generated
and contains the users_guide documentation.
** Publish the release on internet
** Publish the release on internet
TODO - Write how to publish the source tarball, especially where
A git tag must be first created, for example
(gforge, gitlab, elsewhere?).
#+begin_src sh
git tag -a v1.0.0 -m 'Version 1.0.0'
git push --tags
#+end_src
Then in the Chameleon *Tags* tab,
https://gitlab.inria.fr/solverstack/chameleon/tags, edit the
release notes and attach the tarball previously generated.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment