Skip to content

Commit

Permalink
Some textual changes explaining how to get help (#174)
Browse files Browse the repository at this point in the history
* Some textual changes explaining how to get help

* CI maintenance
  • Loading branch information
N-Wouda authored Oct 20, 2024
1 parent d47def9 commit b53c225
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 16 deletions.
23 changes: 10 additions & 13 deletions .github/workflows/alns.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,28 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ '3.8', '3.9', '3.10', '3.11' ]
python-version: [ '3.9', '3.10', '3.11', '3.12' ]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Update pip and poetry
run: |
python -m pip install --upgrade pip
pip install poetry
- name: Get current time
uses: josStorer/get-current-time@v2.0.2
id: current-time
- name: Cache Python dependencies
uses: actions/cache@v3
uses: actions/cache@v4
id: cache-python
with:
path: ~/.cache/pypoetry
key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-${{ steps.current-time.outputs.year }}-${{ steps.current-time.outputs.month }}
key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}
- name: Install Python dependencies
if: steps.cache-python.outputs.cache-hit != 'true'
run: poetry install
- name: Cache pre-commit
uses: actions/cache@v3
uses: actions/cache@v4
id: cache-pre-commit
with:
path: ~/.cache/pre-commit/
Expand All @@ -49,19 +46,19 @@ jobs:
run: poetry run pytest
- name: Run pre-commit
run: poetry run pre-commit run --all-files
- uses: codecov/codecov-action@v3
- uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
deploy:
needs: build
if: github.event_name == 'release' && github.event.action == 'created'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: 3.9
python-version: 3.11
- name: Update pip and poetry
run: |
python -m pip install --upgrade pip
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,10 @@ one!

### Getting help

If you are looking for help, please follow the instructions [here][7].
Feel free to open an issue or a new discussion thread here on GitHub.
Please do not e-mail us with questions, modelling issues, or code examples.
Those are much easier to discuss via GitHub than over e-mail.
When writing your issue or discussion, please follow the instructions [here][7].

### How to cite `alns`

Expand Down
13 changes: 13 additions & 0 deletions docs/source/setup/getting_help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Getting help
Conversations about development and issues take place in the `GitHub repository <https://github.com/N-Wouda/ALNS/>`_.
Feel free to open a new issue if you have something to discuss.

.. note::

Please do not e-mail us with questions, modelling issues, or code examples.
Those are much easier to discuss via GitHub than over e-mail.


Submitting a bug report
-----------------------

Expand All @@ -25,3 +31,10 @@ To limit the amount of time needed to triage your problem, please do the followi
.. code-block:: shell
python -c 'import alns; alns.show_versions()'
Submitting a feature request
----------------------------

Please first browse the existing issues and discussions in the GitHub repository to see if your feature has already been requested.
If it has not, please open a new issue in the repository, using the "Feature request" template.
8 changes: 6 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@ classifiers = [
"Tracker" = "https://github.com/N-Wouda/ALNS/issues"

[tool.poetry.dependencies]
python = "^3.8, <4.0"
numpy = ">=1.18.0"
python = "^3.9, <4.0"
numpy = [
# Numpy 1.26 is the first version of numpy that supports Python 3.12.
{ version = ">=1.18.0", python = "<3.12" },
{ version = ">=1.26.0", python = ">=3.12" }
]
matplotlib = ">=3.5.0"
mabwiser = { version = ">=2.7.1", optional = true }

Expand Down

0 comments on commit b53c225

Please sign in to comment.