Skip to content

Commit b82d17a

Browse files
committed
update version number and docs
1 parent 1e0c5ff commit b82d17a

File tree

258 files changed

+2042
-1025
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

258 files changed

+2042
-1025
lines changed

DEPLOYMENT.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -77,24 +77,14 @@
7777
make -C docs-sphinx open_local_docs
7878
```
7979

80-
14. Authenticate with GitHub Personal Access Token (PAT):
81-
```shell
82-
jq -r .github_personal_access_token.value auth/github/private.json | docker login ghcr.io -u uberfastman --password-stdin
83-
```
84-
85-
15. Deploy the newly-built Docker image with respective major, minor, and patch version numbers to the GitHub Container Registry:
86-
```shell
87-
docker push ghcr.io/uberfastman/yfpy:X.X.X
88-
```
89-
90-
16. Create a git commit:
80+
14. Create a git commit:
9181

9282
```shell
9383
git add .
9484
git commit -m 'commit message'
9585
```
9686

97-
17. Update the git tag with the new version:
87+
15. Update the git tag with the new version:
9888

9989
`git tag -a [tag_name/version] -m [message]`
10090

@@ -103,24 +93,34 @@
10393
git push origin --tags
10494
```
10595

106-
18. Install `twine` (if not already installed):
96+
16. Install `twine` (if not already installed):
10797

10898
```shell
10999
pip install twine
110100
```
111101

112-
19. *(Optional)* Test deployment by building the PyPI packages, recreating the documentation, and deploying to Test PyPI:
102+
17. *(Optional)* Test deployment by building the PyPI packages, recreating the documentation, and deploying to Test PyPI:
113103

114104
```shell
115105
make -C docs-sphinx test_deploy
116106
```
117107

118-
20. Deploy YFPY by building the PyPI packages, recreating the Sphinx documentation, and deploying to PyPI:
108+
18. Deploy YFPY by building the PyPI packages, recreating the Sphinx documentation, and deploying to PyPI:
119109

120110
```shell
121111
make -C docs-sphinx deploy
122112
```
123113

114+
19. *(If needed)* Authenticate with GitHub Personal Access Token (PAT):
115+
```shell
116+
jq -r .github_personal_access_token.value auth/github/private.json | docker login ghcr.io -u uberfastman --password-stdin
117+
```
118+
119+
20. Deploy the newly-built Docker image with respective major, minor, and patch version numbers to the GitHub Container Registry:
120+
```shell
121+
docker push ghcr.io/uberfastman/yfpy:X.X.X
122+
```
123+
124124
21. Create a second git commit with updated version number and documentation:
125125

126126
```shell

VERSION.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# DO NOT EDIT - VERSIONING CONTROLLED BY GIT TAGS
2-
__version__ = "v15.0.1"
2+
__version__ = "v15.0.2"

compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ services:
77
- PYTHON_VERSION_MINOR=11
88
context: .
99
dockerfile: docker/Dockerfile
10-
image: ghcr.io/uberfastman/yfpy:15.0.1 # DO NOT EDIT IMAGE - VERSIONING CONTROLLED BY GIT TAGS
10+
image: ghcr.io/uberfastman/yfpy:15.0.2 # DO NOT EDIT IMAGE - VERSIONING CONTROLLED BY GIT TAGS
1111
platform: linux/amd64
1212
environment:
1313
- RUNTIME_ENVIRONMENT=docker

docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 8663e4d9f4b9266b2374ea9d8afe4ffd
3+
config: bfa3dce9f2a27a4e32e72109547f35bd
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_autosummary/integration.conftest.auth_dir.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>integration.conftest.auth_dir &mdash; YFPY v15.0.1 documentation</title>
7+
<title>integration.conftest.auth_dir &mdash; YFPY v15.0.2 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="../_static/jquery.js?v=5d32c60e"></script>
1818
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d549db01"></script>
19+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e2b1516b"></script>
2020
<script src="../_static/doctools.js?v=888ff710"></script>
2121
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
@@ -39,7 +39,7 @@
3939
<img src="../_static/yfpy-logo.svg" class="logo" alt="Logo"/>
4040
</a>
4141
<div class="version">
42-
v15.0.1
42+
v15.0.2
4343
</div>
4444
<div role="search">
4545
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -1456,7 +1456,11 @@
14561456
<li class="toctree-l2"><a class="reference internal" href="../index.html#usage">Usage</a><ul>
14571457
<li class="toctree-l3"><a class="reference internal" href="../index.html#authentication">Authentication</a></li>
14581458
<li class="toctree-l3"><a class="reference internal" href="../index.html#querying-the-yahoo-fantasy-sports-api">Querying the Yahoo Fantasy Sports API</a></li>
1459-
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a></li>
1459+
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a><ul>
1460+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-development-optional">Docker Development (optional)</a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-image-deployment">Docker Image Deployment</a></li>
1462+
</ul>
1463+
</li>
14601464
</ul>
14611465
</li>
14621466
<li class="toctree-l2"><a class="reference internal" href="../index.html#testing">Testing</a><ul>

docs/_autosummary/integration.conftest.browser_callback.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>integration.conftest.browser_callback &mdash; YFPY v15.0.1 documentation</title>
7+
<title>integration.conftest.browser_callback &mdash; YFPY v15.0.2 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="../_static/jquery.js?v=5d32c60e"></script>
1818
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d549db01"></script>
19+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e2b1516b"></script>
2020
<script src="../_static/doctools.js?v=888ff710"></script>
2121
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
@@ -39,7 +39,7 @@
3939
<img src="../_static/yfpy-logo.svg" class="logo" alt="Logo"/>
4040
</a>
4141
<div class="version">
42-
v15.0.1
42+
v15.0.2
4343
</div>
4444
<div role="search">
4545
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -1456,7 +1456,11 @@
14561456
<li class="toctree-l2"><a class="reference internal" href="../index.html#usage">Usage</a><ul>
14571457
<li class="toctree-l3"><a class="reference internal" href="../index.html#authentication">Authentication</a></li>
14581458
<li class="toctree-l3"><a class="reference internal" href="../index.html#querying-the-yahoo-fantasy-sports-api">Querying the Yahoo Fantasy Sports API</a></li>
1459-
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a></li>
1459+
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a><ul>
1460+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-development-optional">Docker Development (optional)</a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-image-deployment">Docker Image Deployment</a></li>
1462+
</ul>
1463+
</li>
14601464
</ul>
14611465
</li>
14621466
<li class="toctree-l2"><a class="reference internal" href="../index.html#testing">Testing</a><ul>

docs/_autosummary/integration.conftest.chosen_date.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>integration.conftest.chosen_date &mdash; YFPY v15.0.1 documentation</title>
7+
<title>integration.conftest.chosen_date &mdash; YFPY v15.0.2 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="../_static/jquery.js?v=5d32c60e"></script>
1818
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d549db01"></script>
19+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e2b1516b"></script>
2020
<script src="../_static/doctools.js?v=888ff710"></script>
2121
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
@@ -39,7 +39,7 @@
3939
<img src="../_static/yfpy-logo.svg" class="logo" alt="Logo"/>
4040
</a>
4141
<div class="version">
42-
v15.0.1
42+
v15.0.2
4343
</div>
4444
<div role="search">
4545
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -1456,7 +1456,11 @@
14561456
<li class="toctree-l2"><a class="reference internal" href="../index.html#usage">Usage</a><ul>
14571457
<li class="toctree-l3"><a class="reference internal" href="../index.html#authentication">Authentication</a></li>
14581458
<li class="toctree-l3"><a class="reference internal" href="../index.html#querying-the-yahoo-fantasy-sports-api">Querying the Yahoo Fantasy Sports API</a></li>
1459-
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a></li>
1459+
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a><ul>
1460+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-development-optional">Docker Development (optional)</a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-image-deployment">Docker Image Deployment</a></li>
1462+
</ul>
1463+
</li>
14601464
</ul>
14611465
</li>
14621466
<li class="toctree-l2"><a class="reference internal" href="../index.html#testing">Testing</a><ul>

docs/_autosummary/integration.conftest.chosen_week.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>integration.conftest.chosen_week &mdash; YFPY v15.0.1 documentation</title>
7+
<title>integration.conftest.chosen_week &mdash; YFPY v15.0.2 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="../_static/jquery.js?v=5d32c60e"></script>
1818
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d549db01"></script>
19+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e2b1516b"></script>
2020
<script src="../_static/doctools.js?v=888ff710"></script>
2121
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
@@ -39,7 +39,7 @@
3939
<img src="../_static/yfpy-logo.svg" class="logo" alt="Logo"/>
4040
</a>
4141
<div class="version">
42-
v15.0.1
42+
v15.0.2
4343
</div>
4444
<div role="search">
4545
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -1456,7 +1456,11 @@
14561456
<li class="toctree-l2"><a class="reference internal" href="../index.html#usage">Usage</a><ul>
14571457
<li class="toctree-l3"><a class="reference internal" href="../index.html#authentication">Authentication</a></li>
14581458
<li class="toctree-l3"><a class="reference internal" href="../index.html#querying-the-yahoo-fantasy-sports-api">Querying the Yahoo Fantasy Sports API</a></li>
1459-
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a></li>
1459+
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a><ul>
1460+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-development-optional">Docker Development (optional)</a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-image-deployment">Docker Image Deployment</a></li>
1462+
</ul>
1463+
</li>
14601464
</ul>
14611465
</li>
14621466
<li class="toctree-l2"><a class="reference internal" href="../index.html#testing">Testing</a><ul>

docs/_autosummary/integration.conftest.data_dir.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>integration.conftest.data_dir &mdash; YFPY v15.0.1 documentation</title>
7+
<title>integration.conftest.data_dir &mdash; YFPY v15.0.2 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="../_static/jquery.js?v=5d32c60e"></script>
1818
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d549db01"></script>
19+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e2b1516b"></script>
2020
<script src="../_static/doctools.js?v=888ff710"></script>
2121
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
@@ -39,7 +39,7 @@
3939
<img src="../_static/yfpy-logo.svg" class="logo" alt="Logo"/>
4040
</a>
4141
<div class="version">
42-
v15.0.1
42+
v15.0.2
4343
</div>
4444
<div role="search">
4545
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -1456,7 +1456,11 @@
14561456
<li class="toctree-l2"><a class="reference internal" href="../index.html#usage">Usage</a><ul>
14571457
<li class="toctree-l3"><a class="reference internal" href="../index.html#authentication">Authentication</a></li>
14581458
<li class="toctree-l3"><a class="reference internal" href="../index.html#querying-the-yahoo-fantasy-sports-api">Querying the Yahoo Fantasy Sports API</a></li>
1459-
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a></li>
1459+
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a><ul>
1460+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-development-optional">Docker Development (optional)</a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-image-deployment">Docker Image Deployment</a></li>
1462+
</ul>
1463+
</li>
14601464
</ul>
14611465
</li>
14621466
<li class="toctree-l2"><a class="reference internal" href="../index.html#testing">Testing</a><ul>

docs/_autosummary/integration.conftest.game_code.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>integration.conftest.game_code &mdash; YFPY v15.0.1 documentation</title>
7+
<title>integration.conftest.game_code &mdash; YFPY v15.0.2 documentation</title>
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -16,7 +16,7 @@
1616

1717
<script src="../_static/jquery.js?v=5d32c60e"></script>
1818
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
19-
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d549db01"></script>
19+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=e2b1516b"></script>
2020
<script src="../_static/doctools.js?v=888ff710"></script>
2121
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
2222
<script src="../_static/dark_mode_js/default_dark.js?v=fd565c74"></script>
@@ -39,7 +39,7 @@
3939
<img src="../_static/yfpy-logo.svg" class="logo" alt="Logo"/>
4040
</a>
4141
<div class="version">
42-
v15.0.1
42+
v15.0.2
4343
</div>
4444
<div role="search">
4545
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -1456,7 +1456,11 @@
14561456
<li class="toctree-l2"><a class="reference internal" href="../index.html#usage">Usage</a><ul>
14571457
<li class="toctree-l3"><a class="reference internal" href="../index.html#authentication">Authentication</a></li>
14581458
<li class="toctree-l3"><a class="reference internal" href="../index.html#querying-the-yahoo-fantasy-sports-api">Querying the Yahoo Fantasy Sports API</a></li>
1459-
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a></li>
1459+
<li class="toctree-l3"><a class="reference internal" href="../index.html#docker">Docker</a><ul>
1460+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-development-optional">Docker Development (optional)</a></li>
1461+
<li class="toctree-l4"><a class="reference internal" href="../index.html#docker-image-deployment">Docker Image Deployment</a></li>
1462+
</ul>
1463+
</li>
14601464
</ul>
14611465
</li>
14621466
<li class="toctree-l2"><a class="reference internal" href="../index.html#testing">Testing</a><ul>

0 commit comments

Comments
 (0)