Edit bump version configs and associated documentation for updated do…

…cs locations
microbiomedata · Jan 2, 2025 · 74e55a4 · 74e55a4
1 parent 7424e3f
commit 74e55a4
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -12,16 +12,15 @@ values =
 	rc2
 	rc3
 
-[bumpversion:file:setup.py]
-
+# Updates the repo version number in the README and setup.py
 [bumpversion:file:README.md]
-
-[bumpversion:file:MAINTAINERS.md]
-
+[bumpversion:file:setup.py]
 [bumpversion:file:metaMS/__init__.py]
 
-[bumpversion:file:docs/index.rst]
+# Updates the GCMS version number in the docs
+[bumpversion:file:docs/gcms_metabolomics/index.rst]
+[bumpversion:file:MAINTAINERS.md]
 
+# Updates the docker image version in the wdls
 [bumpversion:file:wdl/metaMS_gcms.wdl]
-
 [bumpversion:file:wdl/metaMS_lcmslipidomics.wdl]
diff --git a/.bumpversion_lipid.cfg b/.bumpversion_lipid.cfg
@@ -12,8 +12,9 @@ values =
 	rc2
 	rc3
 
-[bumpversion:file:docs/index_lipid.rst]
-
+# Updates the lipidomics  version number in the docs
+[bumpversion:file:docs/lcms_lipidomics/index_lipid.rst]
 [bumpversion:file:MAINTAINERS.md]
 
+# Updates the lipidomics version number in the metadata generator
 [bumpversion:file:metaMS/nmdc_lipidomics_metadata_generation/metadata_generator.py]
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -55,7 +55,7 @@ To bump *both* the repo and the lipid workflow, run one of the following command
 ### Generate Documentation
 Documentation of the two workflows can be found the docs folder of this repo.
 
-For the lipidomics workflow, edit only the `docs/index_lipid.rst` file.  Once changes are made there, re-render the `docs/index_lipid.html` and the `docs/README_LCMS_LIPID.md` with the following command.  **This should happen after the version numbers are bumped.**
+For the lipidomics workflow, edit only the `docs/lcms_lipidomics/index.rst` file.  Once changes are made there, re-render the `docs/lcms_lipidomics/index.html` and the `docs/lcms_lipidomics/README_LCMS_LIPID.md` with the following command.  **This happens automatically with bumping versions if using the `make major` commands (or similar) above.**
 
     ```sh
     make convert_lipid_rst_to_md

diff --git a/Makefile b/Makefile
@@ -17,17 +17,20 @@ mem:
 major:
 
 	@bumpversion major --allow-dirty
-	@bumpversion major --allow-dirty --config-file .bumpversion_lipid.cfg
+	@make bump_lipid_major
+	@make convert_lipid_rst_to_md
 
 minor:
 
 	@bumpversion minor --allow-dirty
-	@bumpversion minor --allow-dirty --config-file .bumpversion_lipid.cfg
+	@make bump_lipid_minor
+	@make convert_lipid_rst_to_md
 
 patch:
 
 	@bumpversion patch --allow-dirty
-	@bumpversion patch --allow-dirty --config-file .bumpversion_lipid.cfg
+	@make bump_lipid_patch
+	@make convert_lipid_rst_to_md
 
 bump_lipid_major: