hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-28 18:25:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update read-me-project and change format

Browse Source
This commit is contained in:
james
2019-07-29 09:35:45 +01:00
parent faf4727a78
commit a1cabfd030
2 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/ql-documentation/support/read-me-project.rst Normal file
View File

@@ -0,0 +1,15 @@
Publishing this project for a new version
#########################################
To update this project for a new version:
1. Check with the language teams that all information in the ``ql/change-notes/support/`` directory is ready.
2. Open the ``global-conf.py`` file in the ``global-sphinx-files`` directory and change the following variables
to the correct value(s) if necessary:
* ``version =``
* ``release = ``
* If it's the first release of the year, ``copyright =``
3. Commit your changes. The output of the ``doc/sphinx`` PR check should be correct for the new version and ready to publish.

18
docs/ql-documentation/support/read-me-project.txt
View File

@@ -1,18 +0,0 @@
Publishing this project for a new version
#########################################
To update this project for a new version:
#. Check with the language teams that all information in the ``ql/change-notes/support/`` directory is ready.
#. Check that the versions of these files in the ``code`` repository match those in the ``ql`` repository.
That is, there has been a "ql submodule bump" in the ``code`` repository since the last change to those files.
#. Open the ``global-conf.py`` file in the ``global-sphinx-files`` directory and change the following variables
to the correct value(s) if necessary:
* ``version =``
* ``release = ``
* If it's the first release of the year, ``copyright =``
#. Commit your changes. The output of the ``doc/sphinx`` PR check should be correct for the new version and ready to publish.