Skip to content

Commit

Permalink
chore: removed old files related to the template
Browse files Browse the repository at this point in the history
  • Loading branch information
FabricioArendTorres committed Jul 19, 2024
1 parent 2544934 commit 8a56de3
Show file tree
Hide file tree
Showing 6 changed files with 1 addition and 262 deletions.
198 changes: 0 additions & 198 deletions ABOUT_THIS_TEMPLATE.md

This file was deleted.

23 changes: 1 addition & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to develop on this project

streamauc welcomes contributions from the community.
streamAUC welcomes contributions from the community.

**You need PYTHON3!**

Expand Down Expand Up @@ -90,24 +90,3 @@ docs: ## Build the documentation.
switch-to-poetry: ## Switch to poetry package manager.
init: ## Initialize the project based on an application template.
```

## Making a new release

This project uses [semantic versioning](https://semver.org/) and tags releases with `X.Y.Z`
Every time a new tag is created and pushed to the remote repo, github actions will
automatically create a new release on github and trigger a release on PyPI.

For this to work you need to setup a secret called `PIPY_API_TOKEN` on the project settings>secrets,
this token can be generated on [pypi.org](https://pypi.org/account/).

To trigger a new release all you need to do is.

1. If you have changes to add to the repo
* Make your changes following the steps described above.
* Commit your changes following the [conventional git commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
2. Run the tests to ensure everything is working.
4. Run `make release` to create a new tag and push it to the remote repo.

the `make release` will ask you the version number to create the tag, ex: type `0.1.1` when you are asked.

> **CAUTION**: The make release will change local changelog files and commit all the unstaged changes you have.
5 changes: 0 additions & 5 deletions Containerfile

This file was deleted.

26 changes: 0 additions & 26 deletions gen_ref_pages.py

This file was deleted.

8 changes: 0 additions & 8 deletions mkdocs.yml

This file was deleted.

3 changes: 0 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,5 @@ def read_requirements(path):
author="FabricioArendTorres",
packages=find_packages(exclude=["tests", ".github"]),
install_requires=read_requirements("requirements.txt"),
entry_points={
"console_scripts": ["streamauc = streamauc.__main__:main"]
},
extras_require={"test": read_requirements("requirements-test.txt")},
)

0 comments on commit 8a56de3

Please sign in to comment.