RELEASE_NOTES

This file contains a description of the major changes to the EESSI
build-and-deploy bot. For more detailed information, please see the git log.

v0.11.0 (28 January 2026)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* consider all builds for `bot: status [last_build]` command (#357)
  * this also replaces running `curl` by using the `requests` library for one `curl` call

Improvements:
* adds support for new command `bot: cancel jobid:[JOBID] ...` (#359)
  * only the owner of a job can cancel it
  * multiple jobs can be cancelled by specifying multiple `jobid:[JOBID]`
    arguments separated by space

Changes to 'app.cfg' settings (see README.md and app.cfg.example for details):
* CHANGED (required) 'no_build_permission_comment' in section '[buildenv]'
  Note! sites using the old value may see misleading comments added by the bot,
  but the bot will work without the change.
* NEW (required) 'cancel_command' in section '[buildenv]'


v0.10.0 (13 November 2025)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* show builds for different repositories for `bot: status last_build` command (#345)
* fix out of range error for `bot: status last_build` command (#346)
* ensure tarballs with other suffixes than `.tar.gz` are correctly handled (#352, #353)

Improvements:
* improve security aspects due to OpenSSF Scorecard report (#347, #348, #349, #350)

No changes to 'app.cfg' settings.


v0.9.0 (22 August 2025)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Note! Though it is a minor release it includes breaking changes of the bot
configuration and the user interface for triggering build jobs. For details
see below and documentation at https://www.eessi.io/docs/bot/#building

Bug fixes:
* revised and updated app.cfg.example and README.md (#325)

Improvements:
* add support for cloning target repository via ssh (#300)
* major refactoring of the definition of build targets and breaking change in
  bot configuration and of the user interface to trigger builds (#312, #329, #331, #337)
  * `arch_target_map` is replaced by `node_type_map` which provides a more
     comprehensive/flexible approach to define architectures that are available
     for build jobs; for details, see https://github.com/EESSI/eessi-bot-software-layer?tab=readme-ov-file#architecturetargets-section
  * the `repo_target_map` setting is removed because the information is now
    included in the `node_type_map` setting
  * the `initial_comment` setting in the `[submitted_job_comments]` section of the bot configuration
    has been replaced with separate settings: `new_job_instance_repo`, `build_on_arch`, `build_for_arch`, `jobdir`;
    for details, see https://github.com/EESSI/eessi-bot-software-layer/blob/develop/README.md#submitted_job_comments-section
    and the example bot configuration `app.cfg.example`;
  * `bot:build` filters `architecture:` and `accel:` are replaced by `on:` and
    `for:` (for details see documentation at https://www.eessi.io/docs/bot/#building)
* add CI to build and publish smee-client container image (#321, #322)
* make space before bot command optional (#324)
* support template values in the `scontrol` command (#327, #335)
* support additional parameter (`last_build`) for `bot:status` command (#334)

Changes to 'app.cfg' settings (see README.md and app.cfg.example for details):
* REMOVED (required) 'arch_target_map' in section '[architecturetargets]', replaced by
  'node_type_map'
* REMOVED (required) 'repo_target_map' in section '[repo_targets]', replaced by
  'node_type_map'
* NEW (required) 'node_type_map' in section '[architecturetargets]'
* NEW (optional) 'clone_git_repo_via' in section '[buildenv]'
* NEW (required) 'pr_diff_failure' in section '[download_pr_comments]'
* NEW (required) 'pr_diff_tip' in section '[download_pr_comments]'


v0.8.0 (23 May 2025)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* use Ubuntu 24.04 in CI (#316)
* delete pre-existing signature files (#309)

Improvements:
* adding argument `--contain` when launching the build container (#307)
* use the bot instance's name as `namespaces` value in a signature (#308)
* determine test coverage (#311)
* support different levels for when a bot instance creates comments on GitHub (#315)

Changes to 'app.cfg' settings (see README.md and app.cfg.example for details):
* NEW (optional) 'chatlevel' in section '[bot_control]'


v0.7.0 (13 March 2025)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* bot only reports moving to trash_bin when relevant (#292)

Improvements:
* add support for specifying that build job script is located in another repository (#283)
* implement exportvariable filter (#288, #291)
  * see related configuration setting `allowed_exportvars`
* add alternative method to submit job (using `--begin=now+SOME_DELAY`) (#297)
  * also see the new related configuration settings `job_handover_protocol` and `job_delay_begin_factor`
* set the local_tmp that is configured for a site as tmpdir in bot build job script (#299)
* add setting for a script to customize build environment (#302)
* add support for signing tarball and metadata file and uploading signatures to S3 bucket (#303)
* add SSH signing script `sign_verify_file_ssh.sh` (#304)
* updates of the docs (#293, #298)

Changes to 'app.cfg' settings (see README.md and app.cfg.example for details):
* NEW (optional) 'allowed_exportvars' in section '[buildenv]'
* NEW (required) 'awaits_release_hold_release_msg' in section '[submitted_job_comments]'
* NEW (required) 'awaits_release_hold_release_msg' in section '[submitted_job_comments]'
* DEPRECATED (optional) 'awaits_release' in section '[submitted_job_comments]'
* NEW (optional) 'job_delay_begin_factor' in section '[buildenv]'
* NEW (required) 'job_handover_protocol' in section '[buildenv]'
* NEW (optional) 'signing' in section '[deploycfg]'
* NEW (optional) 'site_config_script' in section '[buildenv]'


v0.6.0 (18 September 2024)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Improvements:
* move merged PR job directories to 'trash_bin_dir' (#271)
  * the target directory can be defined with the 'app.cfg' setting 'trash_bin_dir'
  * it uses 'shutil.move' which tries to use 'mv' if source and target are on the
    same filesystem
* add setting to give all jobs a unique name (#273)
* move closed PR job directories to 'trash_bin_dir' (#275)
* add filter for accelerators (#276)
* add support for updating Slurm options through user-defined python module in
  target PR (#277)
* use GitHub API for downloading the diff of a PR (#278)
* add documentation about private repos (#279)
* pass accelerator value to job scripts (via job.cfg) and extend PR comment if
  the 'accelerator' argument is used (#280, #282)

New 'app.cfg' settings (see README.md and app.cfg.example for details):
* (optional) 'allow_update_submit_opts' in section '[buildenv]'
* (required) 'job_name' in section '[buildenv]'
* (required) 'moved_job_dirs_comment' in section '[clean_up]'
* (required) 'trash_bin_dir' in section '[clean_up]'
* (required) 'with_accelerator' in section '[submitted_job_comments]'


v0.5.0 (16 May 2024)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Improvements:
* list authors in source code files where applicable (#261)
* make display of build targets more concise (#262)
* use _bot_jobJOBID.result files created by bot/check-build.sh when determining
  which build artefacts should be deployed (#263)
  * this makes the bot fully agnostic to what it builds
* reorganise declaration, initialisation and use of string constants _and_ verify
* that required configuration settings are defined in 'app.cfg' (#266)


v0.4.0 (28 February 2024)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* fixes issue using wrong values when using the `bot: status` command (#251)

Improvements:
* make bot report when preparing the job working directory failed, for example due to merge conflict in a pull request (#248)
* adding the pull request comment id to the metadata file that is uploaded to the
  the S3 bucket (#247, #249, #250, #253)
* enabling configurable upload directories for tarball and metadata file (#254)
* only make bot respond to pull request comments that contain a bot command (#257)


v0.3.0 (30 January 2024)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* refreshes the token to access GitHub well before it expires (#238)

Improvements:
* adds a new bot command 'status' which provides an overview (table) of all
  finished builds (#237)


v0.2.0 (26 November 2023)
--------------------------

This is a minor release of the EESSI build-and-deploy bot.

Bug fixes:
* adds information on installing and using the smee client on `aarch64` (#233)

Improvements:
* support for running tests inside the same job but after the build step (#222)
  * runs `bot/test.sh` and `bot/check-test.sh` if these are provided in the GitHub repository
  * adds a new setting (`job_test_unknown_fmt`) in the bot's configuration file
* ensure the bot can build for both the EESSI pilot repository (`pilot.eessi-hpc.org`) and `software.eessi.io` (#229)
* support specifying repository-specific buckets via `bucket_name` in configuration file (#230)


v0.1.1 (14 November 2023)
--------------------------

This is a patch release of the EESSI build-and-deploy bot.

Bug fixes:
* omit header in output of `squeue` command run by the job manager (#220)
* make bot compatible with more recent versions of PyGithub (#224)

Improvements:
* added a script to help reducing disk usage by cleaning up tarballs stored by jobs (#217)
* clarified documentation about setting permissions and event subscriptions for the bot (#221)


v0.1.0 (29 September 2023)
--------------------------

This is the first release of the EESSI build-and-deploy bot, which consists of
an event handler (implemented as a GitHub app, see https://docs.github.com/en/apps),
and a job manager component (implemented as Python script).

It provides support for:

* building software via jobs submitted to a Slurm cluster;
* building software for a GitHub repository that includes a `bot/build.sh` and `bot/check-build.sh` script;
* acting on certain GitHub events:
  * opening of pull requests;
  * pull request comment being posted that include bot commands (like `help`, `build`, `show_config`);
  * labeling of pull requests;
* status updates of build jobs via pull request comments;
* access control for sending commands, submitting build jobs, triggering deploys via GitHub accounts;
* uploading of tarballs with built software artefacts to an S3 bucket;
* wide range of configuration settings to run the bot in different Slurm-based environments;

Multiple bot instances can be run in parallel for a single GitHub repository.

For documentation, see:
* high-level overview of the bot: https://www.eessi.io/docs/bot
* instructions for installing and configuring the bot: https://github.com/EESSI/eessi-bot-software-layer/blob/v0.1.0/README.md
* how to use the bot to add software to EESSI: https://www.eessi.io/docs/software_layer/adding_software