Skip to content
This repository was archived by the owner on Nov 4, 2024. It is now read-only.

Commit 3267eca

Browse files
andersy005andersy005
committed
Update placeholders
1 parent f3c9860 commit 3267eca

15 files changed

+94
-101
lines changed

‎.github/dependabot.yml

-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
version: 2
22
updates:
3-
# - package-ecosystem: pip
4-
# directory: "/"
5-
# schedule:
6-
# interval: daily
73
- package-ecosystem: 'github-actions'
84
directory: '/'
95
schedule:

‎.github/workflows/ci.yaml

+15-28
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,21 @@
11
name: CI
22
on:
33
push:
4+
branches:
5+
- main
46
pull_request:
57
schedule:
68
- cron: '0 0 * * *' # Daily “At 00:00”
79
workflow_dispatch: # allows you to trigger manually
810

9-
jobs:
10-
skip-duplicate-jobs:
11-
runs-on: ubuntu-latest
12-
if: |
13-
github.repository == 'ncar-xdev/python-project-template'
14-
outputs:
15-
should_skip: ${{ steps.skip_check.outputs.should_skip }}
16-
steps:
17-
- id: skip_check
18-
uses: fkirc/[email protected]
19-
with:
20-
# For workflows which are triggered concurrently with the same
21-
# contents, attempt to execute them exactly once.
22-
concurrent_skipping: 'same_content_newer'
23-
paths_ignore: '["**/doc/**"]'
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: true
2414

15+
jobs:
2516
build:
2617
name: python-${{ matrix.python-version }}
27-
needs: skip-duplicate-jobs
28-
if: ${{ needs.skip-duplicate-jobs.outputs.should_skip != 'true' }}
18+
if: github.repository == 'ncar-xdev/unison'
2919
runs-on: ubuntu-latest
3020
defaults:
3121
run:
@@ -35,20 +25,17 @@ jobs:
3525
matrix:
3626
python-version: ['3.8', '3.9', '3.10']
3727
steps:
38-
- uses: actions/checkout@v2
39-
- uses: conda-incubator/setup-miniconda@v2
28+
- uses: actions/checkout@v3
29+
- name: Create conda environment
30+
uses: mamba-org/provision-with-micromamba@main
4031
with:
41-
channels: conda-forge,nodefaults
42-
channel-priority: strict
43-
activate-environment: xdev-project-dev
44-
auto-update-conda: false
45-
python-version: ${{ matrix.python-version }}
32+
cache-downloads: true
33+
micromamba-version: 'latest'
4634
environment-file: ci/environment.yml
47-
mamba-version: '*'
48-
use-mamba: true
49-
miniforge-variant: Mambaforge
35+
extra-specs: |
36+
python=${{ matrix.python-version }}
5037
51-
- name: Install xdev-project
38+
- name: Install unison
5239
run: |
5340
python -m pip install -e . --no-deps --force-reinstall
5441
conda list

‎.github/workflows/pypi-release.yaml

+12-5
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ on:
88
jobs:
99
build-artifacts:
1010
runs-on: ubuntu-latest
11-
if: github.repository == 'ncar-xdev/python-project-template'
11+
if: github.repository == 'ncar-xdev/unison'
1212
steps:
13-
- uses: actions/checkout@v2
13+
- uses: actions/checkout@v3
1414
with:
1515
fetch-depth: 0
16-
- uses: actions/setup-python@v3.0.0
16+
- uses: actions/setup-python@v3
1717
name: Install Python
1818
with:
1919
python-version: 3.8
@@ -33,7 +33,7 @@ jobs:
3333
run: |
3434
python -m twine check dist/*
3535
pwd
36-
if [ -f dist/xdev-project-0.0.0.tar.gz ]; then
36+
if [ -f dist/unison-0.0.0.tar.gz ]; then
3737
echo "❌ INVALID VERSION NUMBER"
3838
exit 1
3939
else
@@ -48,7 +48,7 @@ jobs:
4848
needs: build-artifacts
4949
runs-on: ubuntu-latest
5050
steps:
51-
- uses: actions/setup-python@v3.0.0
51+
- uses: actions/setup-python@v3
5252
name: Install Python
5353
with:
5454
python-version: 3.8
@@ -61,6 +61,13 @@ jobs:
6161
ls -ltrh
6262
ls -ltrh dist
6363
64+
- name: Verify the built dist/wheel is valid
65+
if: github.event_name == 'push'
66+
run: |
67+
python -m pip install --upgrade pip
68+
python -m pip install dist/unison*.whl
69+
# python -c "import unison; print(unison.__version__)"
70+
6471
upload-to-pypi:
6572
needs: test-built-dist
6673
if: github.event_name == 'release'

‎.github/workflows/upstream-dev-ci.yaml

+16-13
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
name: Upstream CI
22
on:
33
push:
4+
branches:
5+
- main
46
schedule:
57
- cron: '0 0 * * *' # Daily “At 00:00” UTC
68
workflow_dispatch: # allows you to trigger the workflow run manually
79

10+
concurrency:
11+
group: ${{ github.workflow }}-${{ github.ref }}
12+
cancel-in-progress: true
13+
814
jobs:
915
upstream-dev:
1016
name: upstream-dev
1117
runs-on: ubuntu-latest
18+
if: github.repository == 'ncar-xdev/unison'
1219
defaults:
1320
run:
1421
shell: bash -l {0}
@@ -17,21 +24,18 @@ jobs:
1724
matrix:
1825
python-version: ['3.10']
1926
steps:
20-
- uses: actions/checkout@v2
21-
- uses: conda-incubator/setup-miniconda@v2
27+
- uses: actions/checkout@v3
28+
- name: Create conda environment
2229
id: conda
30+
uses: mamba-org/provision-with-micromamba@main
2331
with:
24-
channels: conda-forge,nodefaults
25-
channel-priority: strict
26-
activate-environment: xdev-project-dev
27-
auto-update-conda: false
28-
python-version: ${{ matrix.python-version }}
29-
environment-file: ci/upstream-dev-environment.yml
30-
mamba-version: '*'
31-
use-mamba: true
32-
miniforge-variant: Mambaforge
32+
cache-downloads: true
33+
micromamba-version: 'latest'
34+
environment-file: ci/environment-upstream-dev.yml
35+
extra-specs: |
36+
python=${{ matrix.python-version }}
3337
34-
- name: Install xdev-project
38+
- name: Install unison
3539
id: install
3640
run: |
3741
python -m pip install -e . --no-deps --force-reinstall
@@ -46,7 +50,6 @@ jobs:
4650
if: |
4751
always()
4852
&& (steps.conda.outcome != 'success' || steps.install.outcome != 'success' || steps.install.outcome != 'success')
49-
5053
uses: actions/github-script@v6
5154
with:
5255
script: |

‎.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ repos:
1616
hooks:
1717
- id: pyupgrade
1818
args:
19-
- '--py37-plus'
19+
- '--py38-plus'
2020

2121
- repo: https://github.com/psf/black
2222
rev: 22.1.0

‎README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# python-project-template
1+
# unison
22

33
| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![Code Coverage Status][codecov-badge]][codecov-link] [![pre-commit.ci status][pre-commit.ci-badge]][pre-commit.ci-link] |
44
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
55
| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] |
66
| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] |
77
| **License** | [![License][license-badge]][repo-link] |
88

9-
An Xdev template for a developing a Python project/package
9+
Automate execution of Jupyter Notebooks from another Notebook or the command line.
1010

11-
[github-ci-badge]: https://img.shields.io/github/workflow/status/ncar-xdev/python-project-template/CI?label=CI&logo=github
12-
[github-ci-link]: https://github.com/ncar-xdev/xdev-project/actions?query=workflow%3ACI
13-
[codecov-badge]: https://img.shields.io/codecov/c/github/ncar-xdev/xdev-project.svg?logo=codecov
14-
[codecov-link]: https://codecov.io/gh/ncar-xdev/xdev-project
15-
[rtd-badge]: https://img.shields.io/readthedocs/xdev-project/latest.svg
16-
[rtd-link]: https://xdev-project.readthedocs.io/en/latest/?badge=latest
17-
[pypi-badge]: https://img.shields.io/pypi/v/xdev-project?logo=pypi
18-
[pypi-link]: https://pypi.org/project/xdev-project
19-
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/xdev-project?logo=anaconda
20-
[conda-link]: https://anaconda.org/conda-forge/xdev-project
21-
[license-badge]: https://img.shields.io/github/license/ncar-xdev/python-project-template
22-
[repo-link]: https://github.com/ncar-xdev/python-project-template
23-
[pre-commit.ci-badge]: https://results.pre-commit.ci/badge/github/ncar-xdev/python-project-template/main.svg
24-
[pre-commit.ci-link]: https://results.pre-commit.ci/latest/github/ncar-xdev/python-project-template/main
11+
[github-ci-badge]: https://img.shields.io/github/workflow/status/ncar-xdev/unison/CI?label=CI&logo=github
12+
[github-ci-link]: https://github.com/ncar-xdev/unison/actions?query=workflow%3ACI
13+
[codecov-badge]: https://img.shields.io/codecov/c/github/ncar-xdev/unison.svg?logo=codecov
14+
[codecov-link]: https://codecov.io/gh/ncar-xdev/unison
15+
[rtd-badge]: https://img.shields.io/readthedocs/unison/latest.svg
16+
[rtd-link]: https://unison.readthedocs.io/en/latest/?badge=latest
17+
[pypi-badge]: https://img.shields.io/pypi/v/unison?logo=pypi
18+
[pypi-link]: https://pypi.org/project/unison
19+
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/unison?logo=anaconda
20+
[conda-link]: https://anaconda.org/conda-forge/unison
21+
[license-badge]: https://img.shields.io/github/license/ncar-xdev/unison
22+
[repo-link]: https://github.com/ncar-xdev/unison
23+
[pre-commit.ci-badge]: https://results.pre-commit.ci/badge/github/ncar-xdev/unison/main.svg
24+
[pre-commit.ci-link]: https://results.pre-commit.ci/latest/github/ncar-xdev/unison/main

‎ci/environment-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: xdev-project-dev
1+
name: unison-dev
22
channels:
33
- conda-forge
44
- nodefaults

‎ci/environment.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: xdev-project-dev
1+
name: unison-dev
22
channels:
33
- conda-forge
44
- nodefaults

‎ci/upstream-dev-environment.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: xdev-project-dev
1+
name: unison-dev
22
channels:
33
- conda-forge
44
- nodefaults

‎docs/source/conf.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@
5353

5454
# General information about the project.
5555
current_year = datetime.datetime.now().year
56-
project = 'xdev-project'
57-
copyright = f'{current_year}, xdev-project developers'
58-
author = 'xdev-project developers'
56+
project = 'unison'
57+
copyright = f'{current_year}, unison developers'
58+
author = 'unison developers'
5959

6060

6161
# The short X.Y version.
@@ -80,7 +80,7 @@
8080

8181
html_context = {
8282
'github_user': 'ncar-xdev',
83-
'github_repo': 'xdev-project',
83+
'github_repo': 'unison',
8484
'github_version': 'main',
8585
'doc_path': 'docs',
8686
}
@@ -101,7 +101,7 @@
101101

102102

103103
# Output file base name for HTML help builder.
104-
htmlhelp_basename = 'xdev-projectdoc'
104+
htmlhelp_basename = 'unisondoc'
105105

106106

107107
# -- Options for LaTeX output --------------------------------------------------
@@ -116,17 +116,17 @@
116116
}
117117

118118

119-
latex_documents = [('index', 'xdev-project.tex', 'xdev-project Documentation', author, 'manual')]
119+
latex_documents = [('index', 'unison.tex', 'unison Documentation', author, 'manual')]
120120

121-
man_pages = [('index', 'xdev-project', 'xdev-project Documentation', [author], 1)]
121+
man_pages = [('index', 'unison', 'unison Documentation', [author], 1)]
122122

123123
texinfo_documents = [
124124
(
125125
'index',
126-
'xdev-project',
127-
'xdev-project Documentation',
126+
'unison',
127+
'unison Documentation',
128128
author,
129-
'xdev-project',
129+
'unison',
130130
'One line description of project.',
131131
'Miscellaneous',
132132
)

‎docs/source/how-to/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ How to:
66
---
77
maxdepth: 1
88
---
9-
install-xdev-project.md
9+
install-unison.md
1010
1111
```

‎docs/source/how-to/install-xdev-project.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Install xdev-project
1+
# Install unison
22

3-
xdev-project can be installed in three ways:
3+
unison can be installed in three ways:
44

55
```{eval-rst}
66
.. tab:: pip
@@ -9,7 +9,7 @@ xdev-project can be installed in three ways:
99
1010
.. code:: bash
1111
12-
$ python -m pip install xdev-project
12+
$ python -m pip install unison
1313
1414
.. tab:: conda
1515
@@ -18,16 +18,16 @@ xdev-project can be installed in three ways:
1818
1919
.. code:: bash
2020
21-
$ conda install xdev-project --channel conda-forge
21+
$ conda install unison --channel conda-forge
2222
2323
.. tab:: Development version
2424
2525
To install a development version from source:
2626
2727
.. code:: bash
2828
29-
$ git clone https://github.com/ncar-xdev/xdev-project
30-
$ cd xdev-project
29+
$ git clone https://github.com/ncar-xdev/unison
30+
$ cd unison
3131
$ python -m pip install -e .
3232
3333
```

‎docs/source/index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Welcome to xdev-project's documentation!
1+
# Welcome to unison's documentation!
22

3-
xdev-project ...
3+
unison ...
44

55
## Get in touch
66

7-
- If you encounter any errors or problems with **xdev-project**, please open an issue at the GitHub [main repository](https://github.com/ncar-xdev/xdev-project/issues).
8-
- If you have a question like "How do I find x?", ask on [GitHub discussions](https://github.com/ncar-xdev/xdev-project/discussions). Please include a self-contained reproducible example if possible.
7+
- If you encounter any errors or problems with **unison**, please open an issue at the GitHub [main repository](https://github.com/ncar-xdev/unison/issues).
8+
- If you have a question like "How do I find x?", ask on [GitHub discussions](https://github.com/ncar-xdev/unison/discussions). Please include a self-contained reproducible example if possible.
99

1010
```{toctree}
1111
---
@@ -23,12 +23,12 @@ reference/index.md
2323
```{toctree}
2424
---
2525
maxdepth: 2
26-
caption: Contribute to xdev-project
26+
caption: Contribute to unison
2727
hidden:
2828
---
2929
3030
changelog.md
31-
GitHub Repo <https://github.com/ncar-xdev/xdev-project>
32-
GitHub discussions <https://github.com/ncar-xdev/xdev-project/discussions>
31+
GitHub Repo <https://github.com/ncar-xdev/unison>
32+
GitHub discussions <https://github.com/ncar-xdev/unison/discussions>
3333
3434
```

0 commit comments

Comments
 (0)