Skip to content

Commit

Permalink
Update dev.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wspr authored May 18, 2024
1 parent 112daba commit 0f5e8bf
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions doc/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The PDF documentation are built using

l3build doc

These are built with proprietry fonts if available and otherwise fall back on freely available fonts through a standard TeX Live installation.

## Dependencies

Expand Down Expand Up @@ -61,3 +62,17 @@ When running all test files, I often like to use

This set of options randomises the order of the tests and stops after the first failure.


## Release procedure

As the rate of development of fontspec has varied over time, I have found it necessary to automate the release proceedure so as to avoid forgetting any of the important steps.

These are the steps to follow to release the package to CTAN:

* Finalise record of changes in `CHANGES.md`. The topmost tag is used to populate the version number.
* Be in the `develop` branch, freshly `pull`ed and fully `commit`ted.
* Run `lua autorelease.lua` and follow the prompts.

This script will ensure that the `master` and `develop` branch are kept properly in sync, the repository is tagged with the correct version, and `l3build ctan` and `l3build upload` are used to send the package off to CTAN.

A [Github Action](https://github.com/latex3/fontspec/actions) will then convert the tagged commit into a [release](https://github.com/latex3/fontspec/releases).

0 comments on commit 0f5e8bf

Please sign in to comment.