From d85bfb17fd355c4e9098c8eaa71eebdc08f353de Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Wed, 4 Dec 2024 10:14:24 +0100 Subject: [PATCH 1/4] docs(readme): Correct typo in instructions to migrate existing repos Signed-off-by: Paul Mars --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 41260df..15d5daf 100644 --- a/README.rst +++ b/README.rst @@ -85,7 +85,8 @@ Migrate existing projects #. If you're rebasing a library, add the integrations tests structure. Applications should use spread for integration tests. -# Finally, once all files are manually synced, actually sync the git history: +#. Finally, once all files are manually synced, actually sync the git history: + - ``git remote add starbase git@github.com:canonical/starbase.git`` - ``git merge --allow-unrelated-histories starbase/main`` - ``git remote remove starbase`` From 2f664d6be4a07b84e68e24538eaba57178111d92 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Wed, 4 Dec 2024 14:09:08 +0100 Subject: [PATCH 2/4] docs(readme): add instructions to sync with starbase When creating a new project make it clear that the history must be synced with the starbase one. Signed-off-by: Paul Mars --- README.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.rst b/README.rst index 15d5daf..1b1b24f 100644 --- a/README.rst +++ b/README.rst @@ -100,6 +100,12 @@ Create a new project -------------------- #. `Use this template`_ to create your repository. +#. Sync the git history with starbase to ease future merging: + - ``git clone `` + - ``git remote add starbase git@github.com:canonical/starbase.git`` + - ``git merge --allow-unrelated-histories starbase/main`` + - ``git push -f origin main`` + - ``git remote remove starbase`` #. Ensure the ``LICENSE`` file represents the current best practices from the Canonical legal team for the specific project you intend to release. We use LGPL v3 for libraries, and GPL v3 for apps. From ac199abe2617956da61c0580494190e50f2d07e1 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Wed, 4 Dec 2024 14:09:37 +0100 Subject: [PATCH 3/4] docs(readme): add instruction to replace starbase references Signed-off-by: Paul Mars --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 1b1b24f..2acce3c 100644 --- a/README.rst +++ b/README.rst @@ -110,7 +110,8 @@ Create a new project Canonical legal team for the specific project you intend to release. We use LGPL v3 for libraries, and GPL v3 for apps. #. Rename any files or directories and ensure references are updated. -#. Replace any instances of the word ``Starcraft`` with the product's name. +#. Replace any instances of the words ``Starcraft`` and ``starbase`` with the product's + name. #. Place contact information in a code of conduct. #. Rewrite the README. #. If a Diataxis quadrant (tutorials, how-tos, references, explanations) From ba2d4b7774f1e7b7ac967145700b099aa920d317 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Wed, 4 Dec 2024 14:12:58 +0100 Subject: [PATCH 4/4] build(tools): use a single name for targets When 2 targets are define on the same line in the Makefile, the `make help` command does not properly parse the line and display the ##- prefix. Limit ourselves to a single name per target to keep the help generation fairly simple. Signed-off-by: Paul Mars --- common.mk | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common.mk b/common.mk index 4e6b0a9..9c9ea09 100644 --- a/common.mk +++ b/common.mk @@ -118,7 +118,7 @@ lint-docs: ##- Lint the documentation uv run --extra docs sphinx-lint --max-line-length 88 --enable all $(DOCS) .PHONY: lint-twine -lint-twine: dist/* ##- Lint Python packages with twine +lint-twine: pack-pip ##- Lint Python packages with twine uv tool run twine check dist/* .PHONY: test @@ -149,7 +149,7 @@ docs-auto: ## Build and host docs with sphinx-autobuild uv run --extra docs sphinx-autobuild -b html --open-browser --port=8080 --watch $(PROJECT) -W $(DOCS) $(DOCS)/_build .PHONY: pack-pip -pack-pip dist/*: ##- Build packages for pip (sdist, wheel) +pack-pip: ##- Build packages for pip (sdist, wheel) uv build . # Below are intermediate targets for setup. They are not included in help as they should