Release 0.1.1a1 (#38)

* Updating installation instructions for new version.
* Adding changelog
* Addressing md lints
* Running link check after merge to main.

.github/workflows/link_and_spell_check.yml

@@ -1,4 +1,7 @@
 on:
+  push:
+    branches:
+    - main
   workflow_dispatch:
   pull_request:
     branches:
@@ -35,7 +38,8 @@ jobs:
       uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
         use-verbose-mode: 'yes'
-      if: ${{ success() || failure() }}
+        config-file: 'utils/mlc_config.json'
+      if: ${{ github.event_name == 'push' }}
     - name: "Check spelling in changed files"
       # cspell:words streetsidesoftware
       uses: streetsidesoftware/[email protected]

Changelog.md

@@ -0,0 +1,37 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.1.1a1] - 2022-01-31
+
+### Core
+
+- Enhance error messages when accessing qubit and registers [#11](https://github.com/qir-alliance/pyqir/pull/11)
+- Updating `microsoft-quantum-qir-runtime-sys` to [f4f281236](https://github.com/microsoft/qsharp-runtime/commit/f4f28123601d8372a5fe120bdab1f2be25b51522) on main [#14](https://github.com/qir-alliance/pyqir/pull/14)
+- Updating `pyo3` and `maturin` to latest versions. [#16](https://github.com/qir-alliance/pyqir/pull/16)
+- Creating bare context/module/builder for JIT'ing [#17](https://github.com/qir-alliance/pyqir/pull/17)
+- Adding cargo fmt/clippy checks on build with associated code fixes. [#21](https://github.com/qir-alliance/pyqir/pull/21)
+- Support running modules with a custom entry point name or multiple entry points [#23](https://github.com/qir-alliance/pyqir/pull/23)
+- Support loading modules from memory and clean up module loading API [#24](https://github.com/qir-alliance/pyqir/pull/24)
+
+### Infrastructure
+
+- Documentation and Cleanup for Release [#1](https://github.com/qir-alliance/pyqir/pull/1)
+- Adding Mock language for Bernstein-Vazirani generation example [#4](https://github.com/qir-alliance/pyqir/pull/4)
+- Properly picking up markdown lint config [#5](https://github.com/qir-alliance/pyqir/pull/5)
+- Removed markdown lint workflow to take the org template instead [#6](https://github.com/qir-alliance/pyqir/pull/6)
+- Create link and spell check validations [#7](https://github.com/qir-alliance/pyqir/pull/7)
+- Added and updates readmes [#8](https://github.com/qir-alliance/pyqir/pull/8)
+- Adding a contribution guide and a link to the code of conduct [#9](https://github.com/qir-alliance/pyqir/pull/9)
+- Run generator and jit examples as part of the CI. [#10](https://github.com/qir-alliance/pyqir/pull/10)
+- Update Instructions for Examples [#13](https://github.com/qir-alliance/pyqir/pull/13)
+- Create Linux container smoke tests during CI [#22](https://github.com/qir-alliance/pyqir/pull/22)
+- Build conceptual and API docs with Sphinx [#30](https://github.com/qir-alliance/pyqir/pull/30)
+- Fix documentation links that couldn't be checked as part of the first docs PR [#37](https://github.com/qir-alliance/pyqir/pull/37)
+
+## 0.1.0a1 - 2021-11-24
+
+- Initial Release
+
+[Unreleased]: https://github.com/qir-alliance/pyqir/compare/v0.1.1a1...HEAD
+[0.1.1a1]: https://github.com/qir-alliance/pyqir/compare/v0.1.0a1...v0.1.1a1

docs/getting-started/installing.md

@@ -23,24 +23,24 @@ conda install -c conda-forge gh
 ### Download the Release
 
 From within the repository root folder, run the following command to download
-the desired version for your platform, e.g. for `v0.1.0a1`:
+the desired version for your platform, e.g. for `v0.1.1a1`:
 
 - on Linux:
 
   ```bash
-  gh release download v0.1.0a1 -D wheelhouse -R qir-alliance/pyqir --pattern "*-manylinux*_x86_64.whl"
+  gh release download v0.1.1a1 -D wheelhouse -R qir-alliance/pyqir --pattern "*-manylinux*_x86_64.whl"
   ```
 
 - on Mac OS:
 
   ```bash
-  gh release download v0.1.0a1 -D wheelhouse -R qir-alliance/pyqir --pattern "*-macosx_*_x86_64.whl"
+  gh release download v0.1.1a1 -D wheelhouse -R qir-alliance/pyqir --pattern "*-macosx_*_x86_64.whl"
   ```
 
 - on Windows:
 
   ```bash
-  gh release download v0.1.0a1 -D wheelhouse -R qir-alliance/pyqir --pattern "*-win_amd64.whl"
+  gh release download v0.1.1a1 -D wheelhouse -R qir-alliance/pyqir --pattern "*-win_amd64.whl"
   ```
 
 ### Install the Packages