feat: 2.1 preparations (#1876)

* Release preparations

* Fix workflow warning

* Fix test with hardcoded index version

* fix: executable permissions

* feat: improved error message for unknown predefined variables in env (#1875)

Now full message mentions the fact that this evaluation is expected for
prededefined variables and the offending key is printed.

Example:
```
error: Unknown predefined variable in environment variable 'PATH' of 'alr': Unknown formatting key: HOME
```

* fix: assorted bitrot since last release

* fix: Windows installer

---------

Co-authored-by: Manuel <mgrojo@gmail.com>

Author: mosteo

.github/workflows/ci-release.yml

@@ -236,16 +236,17 @@ jobs:
         with:
           name: alr-bin-${{ matrix.platform.id }}.zip
 
-      # On Windows runners, 7zip is available instead of zip. Rather than
-      # installing zip from MSYS2 we simply use 7zip.
-
-      - name: Package binaries (non-Windows)
-        if: matrix.platform.os != 'windows-latest'
-        run: zip alr-bin.zip bin/alr* LICENSE.txt
-
-      - name: Package binaries (Windows)
+      # On Windows, install zip as it is not available by default
+      - name: Install zip (Windows)
         if: matrix.platform.os == 'windows-latest'
-        run: 7z a alr-bin.zip bin/alr.exe LICENSE.txt
+        run: choco install zip
+
+      - name: Package binaries
+        shell: bash
+        # Mark executable as artifacts remove the executable bit
+        run: |
+          chmod +x bin/alr*
+          zip alr-bin.zip bin/alr* LICENSE.txt
 
       - name: Upload binary assets
         uses: actions/upload-release-asset@v1
@@ -278,6 +279,15 @@ jobs:
       with:
         name: alr-bin-x86_64-windows.zip
 
+    - name: Copy to preinstall location
+      shell: bash
+      run: |
+        INSTALL_DIR=$PWD/alr_install
+        echo "INSTALL_DIR=$INSTALL_DIR" >> $GITHUB_ENV
+        mkdir -p $INSTALL_DIR/bin
+        cp bin/alr.exe $INSTALL_DIR/bin
+        cp LICENSE.txt $INSTALL_DIR
+
     # We need to install MSYS2 again. This is a bit wasteful since the build
     # job already did it, but at least this way things are more clearly
     # separated. If we rely on an existing Alire, we might hit the cache rather
@@ -310,7 +320,7 @@ jobs:
       shell: bash
       working-directory: scripts/installer/
       env:
-        ALR_INSTALL_DIR: ${{ runner.temp }}/alr_install
+        ALR_INSTALL_DIR: ${{ env.INSTALL_DIR }}
         ALR_INSTALL_OS: ${{ runner.os }}
 
     - name: Upload installer
@@ -422,7 +432,8 @@ jobs:
 
     - name: Get ref version
       id: get_ref
-      run: echo "::set-output name=short_sha::$(echo ${{ github.sha }} | cut -c1-8)"
+      run: echo "short_sha=$(echo ${{ github.sha }} | cut -c1-8)" >> $GITHUB_OUTPUT
+      shell: bash
 
     - name: Upload as artifact
       uses: actions/upload-artifact@v4
@@ -447,6 +458,9 @@ jobs:
         with:
           name: alr-${{needs.appimage.outputs.short_sha}}-x86_64.AppImage.zip
 
+      - name: Mark as executable
+        run: chmod +x alr.AppImage
+
       - name: Upload AppImage asset
         if: (github.event_name == 'release')
         uses: actions/upload-release-asset@v1
@@ -461,12 +475,12 @@ jobs:
   ###################
   # release-nightly #
   ###################
-  
+
   release-nightly:
     name: Nightly release on ${{ matrix.platform.id }}
-    if: > 
-      github.event_name == 'schedule' 
-      || (github.event_name == 'workflow_dispatch' && github.event.inputs.release_nightly != 'false') 
+    if: >
+      github.event_name == 'schedule'
+      || (github.event_name == 'workflow_dispatch' && github.event.inputs.release_nightly != 'false')
       || (github.event_name == 'pull_request' && contains(github.event.pull_request.title, 'nightly'))
     needs: [build, build-macos-universal]
     runs-on: ${{ matrix.platform.os }}
@@ -508,16 +522,18 @@ jobs:
         id: date
         run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
         shell: bash
-  
+
       - name: Get metadata
         run: |
           touch alr-date-is-${{steps.date.outputs.date}}.txt
           touch alr-commit-is-${{github.sha}}.txt
         shell: bash
 
       - name: Package binaries
-        run: zip alr-nightly-bin-${{matrix.platform.id}}.zip bin/alr* LICENSE.txt alr-*.txt
-        
+        run: |
+          chmod +x bin/alr*
+          zip alr-nightly-bin-${{matrix.platform.id}}.zip bin/alr* LICENSE.txt alr-*.txt
+
       # The uploader needs Python with the github module
 
       - name: Set up Python
@@ -541,8 +557,8 @@ jobs:
   release-nightly-appimage:
     name: Nightly AppImage
     if: >
-      github.event_name == 'schedule' 
-      || (github.event_name == 'workflow_dispatch' && github.event.inputs.release_nightly != 'false') 
+      github.event_name == 'schedule'
+      || (github.event_name == 'workflow_dispatch' && github.event.inputs.release_nightly != 'false')
       || (github.event_name == 'pull_request' && contains(github.event.pull_request.title, 'nightly'))
     needs: [appimage]
     runs-on: ubuntu-22.04
@@ -555,12 +571,14 @@ jobs:
           name: alr-${{needs.appimage.outputs.short_sha}}-x86_64.AppImage.zip
 
       - name: Rename binary
-        run: mv alr.AppImage alr-nightly-x86_64.AppImage
+        run: |
+          chmod +x alr.AppImage
+          mv alr.AppImage alr-nightly-x86_64.AppImage
 
       - name: Upload to release
         uses: pyTooling/Actions/releaser/composite@r4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}          
+          token: ${{ secrets.GITHUB_TOKEN }}
           tag: nightly
           rm: false
           files: alr-nightly-x86_64.AppImage

.gitignore

@@ -2,6 +2,8 @@
 
 .clang-format
 .clangd/
+.repomix
+.vscode
 
 *.cgpr
 *.db

BREAKING.md

@@ -1,10 +1,13 @@
-Log of breaking changes in index or alr.
+Log of breaking changes in index or alr. Future versions are as of today and
+may change.
 
 ### alr 3.0.0 + index 1.4.0
 
 - alr: removed `ALR_CONFIG` environment variable.
 - alr: removed `alr config` command.
 
+### We are here
+
 ### alr 2.1.0 + index 1.4.0
 
 - index: git remotes in origins are recognized even without `git+` prefix

RELEASING-post.md

@@ -0,0 +1,9 @@
+## Checklist after releasing a new version
+
+1. [ ] Update versions (to -dev)
+  - `Alire.Version`
+  - `alire.toml`
+1. [ ] Publish `alr` in community index?
+  - [ ] Release as many dependencies as possible (all needed)
+  - [ ] Remove corresponding pins
+  - [ ] Publish (but with caveat? It will not be the same exact build)

RELEASING.md

@@ -1,29 +1,29 @@
 ## Checklist for releasing a new version
 
 1. [ ] Update Msys2 installer at https://github.com/msys2/msys2-installer/releases/
-1. [ ] Run local-only tests (`/testsuite/run-dev.sh`)
 1. [ ] Update versions
   - `Alire.Version`
   - `alire.toml`
   - `user-changes.md`
+1. [ ] In repo `alire-index`: create new index version branches if necessary.
+  - Edit index/index.toml to match.
+1. [ ] Run all tests (regular+local) (`/testsuite/run-dev.sh`)
 1. [ ] Create test release in own fork.
   - To verify builds succeed.
   - As the Windows build can rarely fail, this provides a backup .exe
-1. [ ] In repo `alire-index`: create new index version branches if necessary.
-  - Edit index/index.toml to match.
+1. [ ] Create a proper release in alire-project/alire
+  - Tag corresponding commit as vX.X.X (github does it if missing).
+  - Use autogenerated release notes.
+  - Credit all collaborators (if release notes aren't exhaustive).
 1. [ ] Ensure the index version is the default branch in the community repos:
   - alire-index
   - alire-index-checks (must match alire-index)
   - alire-index-staging (when it exists)
   - test-index
-1. [ ] Create a proper release in alire-project/alire
-  - Tag corresponding commit as vX.X.X (github does it if missing).
-  - Use autogenerated release notes.
-  - Credit all collaborators (if release notes aren't exhaustive).
-1. Update Alire.Version and alire.toml to -dev in release branch.
+1. [ ] Update Alire.Version and alire.toml to -dev in release branch.
 1. [ ] Update stable version used in alire-index workflows
   - We used to use default in setup-alire, but by making it explicit we can
     test the new release before making it the default for everyone (next step).
-1. After a screening period, update default version in setup-alire repo.
+1. [ ] After a screening period, update default version in setup-alire repo.
   - For major Alire versions with breaking changes, bump the setup-alire
     version too.

alire.toml

@@ -1,7 +1,7 @@
 name = "alr"
 description = "Command-line tool from the Alire project"
 
-version = "2.1-dev"
+version = "2.1.0"
 
 authors = ["Alejandro R. Mosteo", "Fabien Chouteau", "Pierre-Marie de Rodat"]
 maintainers = ["alejandro@mosteo.com", "chouteau@adacore.com"]

doc/user-changes.md

@@ -4,6 +4,8 @@ This document is a development diary summarizing changes in `alr` that notably
 affect the user experience. It is intended as a one-stop point for users to
 stay on top of `alr` new features.
 
+## Release `2.2`
+
 ## Release `2.1`
 
 ### New `--format` global switch to produce structured output
@@ -18,7 +20,7 @@ select the desired output language:
 
 ```
 $ alr --format=TOML search --crates hello
-[[data]]                                        
+[[data]]
 description = "'Hello, world!' demonstration project"
 name = "hello"
 [[data]]

scripts/installer/make-alire-installer

@@ -114,7 +114,8 @@ create_chroot_system() {
   pushd "${_newalire}" > /dev/null
 
 	mkdir -p bin/
-	cp -r "$ALR_INSTALL_DIR"/* .
+  echo "Copying from ${ALR_INSTALL_DIR} to $PWD" | tee -a "${_log}"
+	cp -rv "$ALR_INSTALL_DIR"/* .
 
 	mkdir -p share/alire/
 	cp "${_thisdir}/alr_icon.ico" share/alire/
@@ -126,6 +127,15 @@ then
 	echo "Please set \$ALR_INSTALL_DIR"
 	exit 1
 fi
+
+# Verify it is a folder
+if [ ! -d "$ALR_INSTALL_DIR" ]
+then
+  echo "$ALR_INSTALL_DIR is not a folder"
+  ls -alF "$ALR_INSTALL_DIR"
+  exit 1
+fi
+
 if [[ -z "$ALR_INSTALL_OS" ]]
 then
 	echo "Please set \$ALR_INSTALL_OS"

src/alire/alire-index.ads

@@ -16,6 +16,10 @@ with Semantic_Versioning.Extended;
 
 package Alire.Index is
 
+   Community_Branch : constant String := "stable-1.4.0";
+   --  The branch used for the community index. Must be updated when new index
+   --  features are introduced.
+
    Community_Host : constant String := Settings.Builtins.Index_Host.Get;
 
    Community_Organization : constant String :=
@@ -26,8 +30,8 @@ package Alire.Index is
 
    Community_Repo : constant URL :=
                       "git+" & Community_Host
-                      & "/" & Community_Organization
-                      & "/" & Community_Repo_Name;
+                      & "/"  & Community_Organization
+                      & "/"  & Community_Repo_Name;
    --  Default index installed on first run
 
    Community_Name : constant Restricted_Name := "community";
@@ -45,10 +49,6 @@ package Alire.Index is
      and then Branch_String (Branch_String'Last) /= '-'
      and then (for some C of Branch_String => C = '-');
 
-   Community_Branch : constant String := "stable-1.3.0";
-   --  The branch used for the community index. Must be updated when new index
-   --  features are introduced.
-
    Min_Compatible_Version : constant Semantic_Versioning.Version;
    --  Based on the constant defined in private section
 

src/alire/alire-version.ads

@@ -12,11 +12,8 @@ private
 
    --  Remember to update Alire.Index branch if needed too
 
-   --  NOTE: in the following version string, the build part (after '+') will
-   --  be replaced by `alr build` with the current commit, and appended with
-   --  "_or_later" after build.
-
-   Current_Str : constant String := "2.1.0-dev";
+   Current_Str : constant String := "2.1.0";
+   --  2.1.0:     new solver and other internal largish refactorings, bugfixes
    --  2.0.2:     quarterly bugfix maintenance release
    --  2.0.1:     fix `alr install` and minor fixes
    --  2.0.0:     alr settings refactor and minor fixes