Bump version to 0.1.0

Author: jonaprieto

.changelog/config.toml

@@ -1,5 +1,5 @@
 project_url = "https://github.com/anoma/nspec"
-heading = "# Change Log"
+heading = "---\nicon: octicons/log-16\nsocial:\n  cards: false\nsearch:\n    exclude: false\nlist_wikilinks: false\n---\n\n# Change Log"
 change_template = "change_template.md"
 wrap = 120 # better for MkDocs
 bullet = "-"

.changelog/v0.1.0/features/repo/209-use-unclog.md

@@ -1,2 +1 @@
-- Add changelog management system
-  ([\#209](https://github.com/anoma/nspec/pull/209))
+  - [**#209**](https://github.com/anoma/nspec/pull/209): Add changelog management system

.changelog/unreleased/features/repo/214-repo214.md renamed to .changelog/v0.1.0/features/repo/214-repo214.md

@@ -2,6 +2,7 @@ name: deploy
 'on':
   push:
     branches:
+      - main
       - v*
 env:
   CI: true
@@ -118,7 +119,7 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4.6.4
         with:
           folder: ${{ env.BRANCH_NAME }}
-          target-folder: latest
+          target-folder: ${{ env.BRANCH_NAME == 'main' && 'latest' || env.BRANCH_NAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
           clean: false
           git-config-name: Anoma Research

.github/workflows/deploy.yml

@@ -25,7 +25,7 @@ repos:
         entry: filenames must be lower
         language: fail
         files: '[^a-z0-9._/]'
-        exclude: '.pre-commit.*|^overrides.*|^docs/(assets|images)/|^formal.*|.*Package.juvix.*|^\.github/.*|CITATION|LICENSE|Makefile|README\.md|VERSION'
+        exclude: '.pre-commit.*|^overrides.*|^docs/(assets|images)/|^formal.*|.*Package.juvix.*|^\.github/.*|CITATION|LICENSE|Makefile|README\.md|VERSION|.changelog/.*'
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
     rev: 3.0.0
     hooks:

.pre-commit-config.yaml

@@ -1,5 +1,4 @@
 PORT?=8000
-VERSION?=$(shell cat VERSION)
 PIP?=pip3
 
 PWD=$(CURDIR)
@@ -43,42 +42,6 @@ test-build:
 art.bib:
 	@curl -s -o docs/references/art.bib https://art.anoma.net/art.bib || echo "[!] Failed to download art.bib"
 
-.PHONY: serve
-serve:
-	mkdocs serve --dev-addr localhost:${PORT} --config-file ${MKDOCSCONFIG} ${MKDOCSFLAGS}
-
-.PHONY : mike
-mike:
-	@git fetch --all
-	@git checkout gh-pages
-	@git pull origin gh-pages --rebase
-	@git checkout ${GITBRANCH}
-	mike deploy ${VERSION} ${MIKEFLAGS} -t ${VERSION}
-
-.PHONY: mike-serve
-mike-serve: docs
-	mike serve --dev-addr localhost:${PORT} --config-file ${MKDOCSCONFIG}
-
-.PHONY: delete-alias
-delete-alias:
-	mike delete ${VERSION} ${MIKEFLAGS} > /dev/null 2>&1 || true
-
-.PHONY: deploy
-deploy:
-	${MAKE} delete-alias
-	${MAKE} mike
-	DEFAULTVERSION=$(shell cat VERSION); \
-	if [ "${VERSION}" = "${DEFAULTVERSION}" ]; then \
-		mike set-default ${MIKEFLAGS} ${DEFAULTVERSION}; \
-		mike alias ${VERSION} latest -u ${MIKEFLAGS}; \
-	fi; \
-	git tag -d ${VERSION} > /dev/null 2>&1 || true; \
-	git tag -a ${VERSION} -m "Release ${VERSION}"
-
-install:
-	@echo "[!] Use a Python virtual environment if you are not using one."
-	${PIP} install -r requirements.txt
-
 .PHONY : pre-commit
 pre-commit :
 	@pre-commit run --all-files

Makefile

@@ -1 +1 @@
-v2
+v0.1.0

VERSION

@@ -1,3 +1,12 @@
+---
+icon: octicons/log-16
+social:
+  cards: false
+search:
+    exclude: false
+list_wikilinks: false
+---
+
 # Change Log
 
 ## v0.1.0
@@ -34,7 +43,6 @@ project per version, with better documentation and descriptions of the changes.
 
 ### BUG FIXES
 
-
 - [Repository maintenance and CI](.)
   - [**#4**](https://github.com/anoma/nspec/pull/4): Fix mike
   - [**#9**](https://github.com/anoma/nspec/pull/9): Add batch of fixes

docs/changelog.md

@@ -8,75 +8,55 @@ tags:
 # Git branching strategy
 
 The general workflow is to branch off from the latest version's branch, perform
-your changes, open a pull request, and merge your updates. An open pull request
-can finalise a version, or patch it with updates.
+your changes, open a pull request, and merge your updates.
 
 ## Branching strategy
 
-For new versions, branch off from the latest version. This is usually done by
-maintainers. Call the branch as `vX`, where `X` is the new version number,
-the successor of the latest version. To find the latest version, check the
-`VERSION` file in the repository root. For example, if the latest version is
-`v1`, the new version branch will be `v2`, and the git graph will look like:
+### For changes to the latest version
+
+For changes to the latest version, branch off from `main`. Name your branch by
+prefixing your name and an issue identifier, like `your-name/issue-identifier`.
+
+```bash
+git checkout main
+git checkout -b your-name/issue-identifier
+```
+
+### For changes to older published versions
+
+For patching older versions, branch off from the specific version branch.
+Published versions follow the pattern `vX`, where `X` is the version number.
+For example, say the latest version is `v0.1.0`.
+
+```bash
+git checkout v0.1.0
+```
+
+Name your branch by prefixing your name and an patch topic, like
+`your-name/patch-topic`.
+
+```bash
+git checkout -b your-name/patch-topic
+```
+
+The git graph will look like:
 
 ```mermaid
 %%{init: { 'theme': 'neutral' } }%%
 gitGraph:
     commit
-    branch v1
-    checkout v1
+    branch vX
+    checkout vX
     commit
     branch your-name/issue-identifier
     checkout your-name/issue-identifier
     commit
-    checkout v1
+    checkout vX
     merge your-name/issue-identifier
-    commit
-    commit tag: "v1"
-    branch v2
-    checkout v2
-    commit
-    commit id:"still in development"
 ```
 
-!!! info
-
-    The branch `vX` is the base branch for all new features and patches for the
-    version `X`. That means that, even when there are new versions, the branch `vX`
-    can still be used for patches and minor updates to the version `X`.
-
-
-## Merging finalised versions
-
-2. To merge a finalised version:
-
-  - Open a pull request against the version in development.
-  - Pass all CI checks.
-  - Tag it with the `vX` label.
-  - Merge the pull request.
-
-### Adding new features to the current version
-
-For patches or minor updates, again, branch off from the latest version. Name
-your branch prefixing your name and an issue identifier, like
-`your-name/issue-identifier`. Short descriptive labels are recommended, like
-`fix-typo`, or `new-solver-engine`. So, the steps are:
-
-1. **Fetch the latest changes**:
-    ```bash
-    git fetch --all
-    ```
-2. **Create a new branch**:
-    ```bash
-    git checkout vX # Replace vX with the current version
-    git checkout -b your-name/issue-identifier
-    ```
-3. Open a pull request against the version in development. If you are using
-   `gh`, after pushing your changes, you can create a pull request with:
-
-    ```bash
-    gh pr create
-    ```
+So, if your PR is merged, the changes will be incorporated into the version
+branch and on the website.
 
 ### Rebasing your work
 
@@ -94,34 +74,41 @@ the following.
 - Initiate the rebase onto the target branch:
 
     ```bash
-    git pull origin vX --rebase
+    git pull origin main --rebase
     ```
 
-    Or merge the changes from the base branch:
+    Or merge the changes from the base branch which is convenient most of the
+    time:
 
     ```bash
-    git merge vX
+    git merge main
     ```
 
 #### Resolve conflicts
 
 - Git will pause for conflict resolution.
 - After resolving each conflict:
-    ```bash
-    git rebase --continue
-    ```
+
+  ```bash
+  git rebase --continue
+  ```
+
 - To stop the rebase process:
-    ```bash
-    git rebase --abort
-    ```
+
+  ```bash
+  git rebase --abort
+  ```
 
 #### Push your changes
 
 - Once rebase is complete, push changes:
+
     ```bash
     git push origin your-name/issue-identifier
     ```
+
 - A force push may be required:
+
     ```bash
     git push origin your-name/issue-identifier --force-with-lease
     ```

docs/tutorial/branch.md

@@ -112,7 +112,7 @@ def nav_to_dict(nav):  # type: ignore
     def dict_to_md(nav_dict, depth=0) -> str:
         if isinstance(nav_dict, list):
             return "\n\n".join(dict_to_md(section, depth) for section in nav_dict)
-        indented_prefix = f"{'    ' * depth}- "
+        indented_prefix = f"{'  ' * depth}- "
         if isinstance(nav_dict, dict):
             if "title" in nav_dict:
                 title = nav_dict["title"]