docs: move docs into a new directory

clabe45 · Jul 5, 2022 · cd44afc · cd44afc
1 parent d45d846
commit cd44afc
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 8 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -63,7 +63,7 @@ jobs:
         uses: mindsers/changelog-reader-action@v2
         with:
           version: ${{ steps.tag_name.outputs.current_version }}
-          path: ./CHANGELOG.md
+          path: ./docs/changelog.md
 
       - name: Publish release to PyPi
         run: pipenv run publish -u __token__ -p ${{ secrets.PYPI_TOKEN }}

diff --git a/README.md b/README.md
@@ -125,6 +125,6 @@ Licensed under the Apache License, Version 2.0.
 
 [yarn's]: https://github.com/FabricMC/yarn
 [Fork]: https://github.com/clabe45/shulkr/fork
-[changelog]: https://github.com/clabe45/shulkr/blob/main/CHANGELOG.md
-[usage guidelines]: https://github.com/clabe45/shulkr/blob/main/usage-guidelines.md
+[changelog]: https://github.com/clabe45/shulkr/blob/main/docs/changelog.md
+[usage guidelines]: https://github.com/clabe45/shulkr/blob/main/docs/usage-guidelines.md
 [DecompilerMC]: https://github.com/hube12/DecompilerMC
diff --git a/CHANGELOG.md → docs/changelog.md b/CHANGELOG.md → docs/changelog.md
diff --git a/usage-guidelines.md → docs/usage-guidelines.md b/usage-guidelines.md → docs/usage-guidelines.md
diff --git a/scripts/bump/__main__.py b/scripts/bump/__main__.py
@@ -2,8 +2,11 @@
 import keepachangelog
 
 
+CHANGELOG_PATH = 'docs/changelog.md'
+
+
 def current_version():
-	changes = keepachangelog.to_dict('CHANGELOG.md')
+	changes = keepachangelog.to_dict(CHANGELOG_PATH)
 	return sorted(changes.keys())[-1]
 
 
@@ -13,18 +16,18 @@ def main():
 	old_version = current_version()
 
 	# Release to get predicted version
-	keepachangelog.release('CHANGELOG.md')
+	keepachangelog.release(CHANGELOG_PATH)
 	predicted_version = current_version()
 
 	# Confirm version
 	user_input = input('New version [{}]: '.format(predicted_version))
 	new_version = user_input or predicted_version
 
 	# Undo temporary release
-	repo.git.restore('CHANGELOG.md')
+	repo.git.restore(CHANGELOG_PATH)
 
 	# Release with confirmed version
-	keepachangelog.release('CHANGELOG.md', new_version)
+	keepachangelog.release(CHANGELOG_PATH, new_version)
 
 	# Update setup.py
 	with open('setup.py', 'r') as setuppy:
@@ -35,7 +38,7 @@ def main():
 
 	# Commit to git
 	commit_message = f'chore: release version {new_version}\n\nBump version {old_version} → {new_version}'
-	repo.git.commit('CHANGELOG.md', 'setup.py', message=commit_message)
+	repo.git.commit(CHANGELOG_PATH, 'setup.py', message=commit_message)
 	repo.git.tag(f'v{new_version}', annotate=True, message=f'version {new_version}')
 
 	print(f'Bumped version {old_version} → {new_version}')