Browse Source

Updated instructions.

dev
Franco Masotti 4 months ago
parent
commit
b0313ca26a
Signed by: frnmst GPG Key ID: 24116ED85666780A
  1. 50
      _pages/software_instructions.md

50
_pages/software_instructions.md

@ -62,9 +62,21 @@ You may contact me directly to obtain the public key fingerprint in a different
- `project_dir`: the full path directory of the project
- `project`: the project name
- `project_python_module`: the python module name of the project (e.g: md-toc is md_toc)
- `project_python_module`: the python module name of the project.
For example: `md-toc` is `md_toc`
- `tag`: the git tag name which is usually [semver](https://semver.org/)ed
- `tag_raw`: same as `tag` but pad each component of the tag with 6 zeros.
For example: `12.121.5` becomes `000012.000121.000005`
- `signing_key`: the public key file used to sign the archive file
- `has_changelog`: the project has a changelog entry for a specific release. Value must be either `true` or `false`
- `is_on_pypi`: the project is on PyPI. Value must be either `true` or `false`
- `project_version_release_date`: the release date of a software version.
This is the command to get the date:
```shell
git log $(git tag | sort --human-numeric-sort --ignore-leading-blanks | tail --lines=1) -n 1 --date=short --format=%ad
```
- `changelog_slugified_header`: the slugified header corresponding to a tag in a changelog file
- `url`: a generic url
- `PyPI_download_page`: the URL of the download page of the package on PyPI
@ -106,7 +118,7 @@ Go into the project directory and then:
#### Update the entry
Create a new entry in this file
Create a new entry in the `_pages/software.md` file
```
- [`${tag}`]({{ site.baseurl }}/software/${project}-${tag}/release.html)
@ -114,38 +126,42 @@ Create a new entry in this file
#### Create a new release file
Create a new file called `${project}-${tag}/release.md` and add the following:
Create a new file called `_software/${project}-${tag}/release.md` and add the following.
If it's not a Python project you must omit `software_name_python_module`:
```
```yaml
---
layout: default
layout: software_release
enable_markdown: true
title: release
excerpt: none
software_name: ${project}
software_name_python_module: ${project_python_module}
software_version: ${tag}
software_version_raw: ${tag_raw}
release_date: ${project_version_release_date}
is_on_pypi: ${is_on_pypi}
has_changelog: ${has_changelog}
signing_public_key: ${signing_key}
---
# ${project}-${tag}
- [CHANGELOG]({{ site.baseurl }}/software/CHANGELOG-${project}.html#${changelog_slugified_header})
- [${project}-${tag}.tar.gz]({{ site.baseurl }}/software/${project}-${tag}.tar.gz)
- [SHA512SUM.txt]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.SHA512SUM.txt)
- [SHA256SUM.txt]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.SHA256SUM.txt)
- [signature]({{ site.baseurl }}/software/${project}-${tag}.tar.gz.sig)
- [signing key]({{ site.baseurl }}/pubkeys/${signing_key})
```
#### Update the changelog
Update the changelog file at `_software/CHANGELOG-${project}.md`:
Add a changelog file in `_software/${project}-${tag}/changelog.md`.
Add the `### Added`, `### Removed`, etc... contents if applicable.
In `./_software/CHANGELOG-${project}.md`:
- update the front matter with the appropriate data:
- `updated` and `date` must be the UTC representation of the timestamp of the
git tag of the last published version
- `last_version` must correspond to the git tag used for the last published version
- move the `<!--last_release_end-->` HTML comment after the last line of the new version
changelog
#### Update the table of contents
Run this command manually or use pre-commit:
md_toc -p github -l 6 software.md
### Download (what you have to do)

Loading…
Cancel
Save