Commit Graph

176 Commits

Author SHA1 Message Date
Daniel Bengtsson 4552af7774 Update the tox minversion parameter.
Update the minversion parameter to use the python -m pip to install
python packages:

https://tox.readthedocs.io/en/latest/changelog.html#id185

It's recommend to use this.

Change-Id: If888ecb343805c0c7f25ad2adfa9ebe98117b6c1
2020-08-12 11:01:26 +02:00
Daniel Bengtsson 6c17b40f5c Fix warning in conf.py file.
The variables repo_name, bug_project and bug_tag is deprecated.

Change-Id: I3ca46982ad336e5ca4241bf08b9349e602fe363b
2020-08-11 11:59:01 +02:00
Hervé Beraud 2204e2dd14 sync oslo-cookiecutter contributing template
Change-Id: I87fd248858923753f708709b62833bfefd67506e
2020-08-10 15:18:39 +00:00
Daniel Bengtsson db278b6103 Add ensure-tox support.
Use ensure_global_symlinks from ensure-tox to fix the CI fail. We need
to do that, because when we install the new sub environment in the new
project the tox is not visible. With the ensure_global_symlinks we do a
symlink into /usr/local/bin path.

Co-authored-by: Bernard Cafarelli <bcafarel@redhat.com>

Change-Id: I575e42fe15f16d0bd51597a540a13c4e384ec096
2020-08-07 15:49:55 +02:00
Zuul 7fc9cd7d52 Merge "Add release notes links to doc index" 2020-05-26 12:32:54 +00:00
Dmitry Tantsur 891773e45a Remove Babel from requirements
It's not a runtime dependency (and even oslo.i18n has dropped it).
The translation infrastructure installs Babel explicitly. See
this mailing list thread for a full reasoning:
http://lists.openstack.org/pipermail/openstack-discuss/2020-April/014227.html

Change-Id: I0decb5537c8d3c920547f4a086b600f7b8782eec
2020-04-17 15:44:08 +02:00
Hervé Beraud a73316582e Add release notes links to doc index
Change-Id: I7ae5625fc5ba6fcfbbbbb941fcc93a85346259a6
2020-04-16 17:18:42 +02:00
Hervé Beraud 6e71d437b5 trivial: refresh template with recent best practices
- add releasenotes to tox
- inherit requirements when is it possible in tox
- switch to hacking 2.x
- add gitignore rules related to reno

Change-Id: Id448fc31474fd29fb0799e96c5f1bb07c83f00bd
2020-04-01 13:56:26 +02:00
Zuul 07011c05c9 Merge "mypy: Add boilerplate configuration" 2020-03-07 20:02:52 +00:00
Hervé Beraud 3862cfa37c mypy: Add boilerplate configuration
Add the requirement, tox job, and basic configuration.

Change-Id: Ib7b2a27ad377c0bb655edad266ce1eeae863d13b
2020-02-12 11:31:13 +01:00
Hervé Beraud 5b43963cc6 remove outdated header
Change-Id: I1f586f3372371db132e228c294bd38ab3b65fcd9
2020-02-10 18:36:21 +01:00
Hervé Beraud 03fea58e82 Drop py27 setuptools/multiprocess fix
Py27 is now dropped we don't need this fix at all

Change-Id: I2490d85abe2e175daad142a0b99348fdffe3ddae
2020-02-04 10:56:17 +01:00
Andreas Jaeger 4648686a27 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Cleanup setup.cfg and remove old cruft.

Change-Id: I706a33405c71bb6dd1c358e7c0f5fea6dc96f7ec
2020-02-03 19:55:04 +01:00
wangfaxin ac356a26a0 Fix openstack review link.
Change-Id: Ib9f2a17938ca63e8c8699037f8fdbf895897822b
2019-11-20 10:29:46 +08:00
Ben Nemec 6a73ff4ddd Use recommended configuration for apidoc
The documentation for apidoc recommends pointing the module_dir at
the module directory itself rather than the top-level directory for
the project so you don't have to explicitly omit setup.py or other
unpackaged Python files.

I did have to remove the _* exclusion because it was breaking in the
current version of Sphinx. It doesn't seem to be necessary in my
testing either. Private files are ignored anyway.

Change-Id: I2f1afcb2a20c3ee0bf8d52c294836e725b5a4e28
2019-06-03 16:00:17 +00:00
Ben Nemec c976c60dff Remove unnecessary setenv
There doesn't seem to be any reason for this, so let's get rid of it
and clean up tox.ini a bit.

Change-Id: Ib7e3635441d5a9be30f4dc1fd72ccf4036b659cc
2019-05-31 20:31:51 +00:00
Ben Nemec a15352f509 Switch cookiecutter tox job to use test_tox_targets.sh
This verifies that the thing we generate will actually pass its
defined tests. It's a superset of the tests we were running before.

Also adds git config calls to make this work in the gate where
the user details aren't already set.

Change-Id: I96810e7cf132304ca700ebedd0c43e3d4d56bbd4
2019-05-31 20:31:45 +00:00
Ben Nemec 62e5b0c629 Fix doc build in test script
There is some additional setup required for the docs to be built.
We need to have an implementation so there is something to add to
the api docs, and openstackdocstheme requires a git commit so it
can get the last modified timestamp. Also, we no longer generate a
Changelog since we aren't using pbr now so we need to remove that
or we have a missing file.

Change-Id: Ic79aa0fb8f7e5813bec420c8b2690b0e9ef79cc2
2019-05-31 18:00:16 +00:00
Ben Nemec 274640e97b Add test script to verify tox targets run
We should be verifying that the tox target defined will run after
generating a project. There's no reason a brand new cookiecutter
repo should have failing tests.

Change-Id: Id142abd2f510a8cbfb42d32fb3f169a63552b981
2019-05-31 18:00:16 +00:00
Ben Nemec 7a6836d522 Fix stestr configuration
.stestr.conf was missing, and in the lower-constraints tests we
weren't getting stestr installed, probably because we were using an
older version of oslotest that didn't depend on it. We should have
an explicit dep on it anyway so it is added to test-requirements.

Some old testr cruft is also cleaned up.

Change-Id: Ia754ee7bc01f87c96ca3e979ec0d6a54001f4bc7
2019-05-31 18:00:16 +00:00
Ben Nemec 87289e42b0 Use sphinxcontrib-apidoc for building api docs
This is the preferred method for building api docs now.

Change-Id: Id05341fa00ae250980a769375cd68f10d3d752b3
2019-05-31 18:00:14 +00:00
Ben Nemec 82fa7b2ca5 Default to python3 in tox testenvs
Other than explicitly python2-based tests, we want to be using
Python 3 for new projects.

Change-Id: Idf49aab9b262cbcc6c4c203f0a2a5429894c968f
2019-05-31 17:59:08 +00:00
Ben Nemec a2a6248e24 Add lower-constraints job to tox
We want to be running this on any new repos we create.

Change-Id: Ic3c048a2ea2e289085e40993927bbb25829804c3
2019-05-31 17:59:08 +00:00
Ben Nemec c1ea4b8c38 Remove git.openstack.org references
This is particularly important for new projects as they may not have
the necessary redirects in place.

Change-Id: If60a49f6e760a573d8f65e973b1e596c3123f901
2019-05-31 17:59:08 +00:00
Ben Nemec ad2ad7e9ea Move constraints from install_command to deps
It's preferred not to have constraints in install_command as that
can cause problems with things like lower-constraints jobs which may
end up with conflicting constraints files. install_command is removed
entirely as it is no longer necessary.

Also updates the location of the constraints file to the releases
address as recommended by the release team.

Change-Id: I1415f66454d7394b6cadb5b0c9bb5b9666d10199
2019-05-31 17:58:00 +00:00
Ben Nemec 415ee2362d Move doc requirements to doc/requirements.txt
This is the standard way to handle doc requirements now.

Change-Id: I2487e70168566506df3c34687ca4cfa1bdd2ef4a
2019-05-31 17:18:28 +00:00
Ben Nemec 9c13fc5548 Remove oslosphinx
It has been retired and we don't want to use it in new projects.
Switch to openstackdocstheme for our Sphinx theme.

Change-Id: Ia41525f1b712e318054d3179d2cd6b0dab39912c
2019-05-31 17:18:28 +00:00
Ben Nemec e5bbd33363 Fix cookiecutter tox tests in gate
It looks like for some reason the script is getting a relative path
in ci, which does not work because we do a find on that path at the
end of the script. This is problematic because at that point we've
already cd'd into a different directory so the relative path is no
longer valid.

To fix this, the find is changed to just look at the current
directory, which is the path we wanted to look at anyway.

Change-Id: I13f046d0df2491d3bba04c3feb0fbac7cd188d3c
2019-05-31 17:18:28 +00:00
OpenDev Sysadmins af7f9f2e9b OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:48:28 +00:00
Jeremy Stanley 17d4c1724e Update contact address to openstack-discuss ML
The openstack-dev mailing list has been retired and its
conversations now take place on openstack-discuss instead.

http://lists.openstack.org/pipermail/openstack-dev/2018-November/136501.html

Update this cookiecutter so that new projects don't copy over the
obsolete ML name.

Change-Id: If987022564d102658f43e95c2c0c45c89469ad7c
2018-11-30 19:05:54 +00:00
melissaml f1dda42f1f change default python 3 env in tox to 3.5
Change-Id: I5a0d4d71247cab9b26a52682259b9636673b586d
2018-11-12 00:24:01 +08:00
Vieri d1a97afc5a Update min tox version to 2.0
The commands used by constraints need at least tox 2.0.  Update to
reflect reality, which should help with local running of constraints
targets.

Change-Id: Idb7268d350a63715e0b1f3a430046ac53bc811bd
2018-11-02 07:46:50 +00:00
Zuul e54567e07d Merge "Don't quote {posargs} in tox.ini" 2018-10-12 15:15:33 +00:00
98k 3df3d423f4 Don't quote {posargs} in tox.ini
Quotes around {posargs} cause the entire string to be combined into one
arg that gets passed to stestr. This prevents passing multiple args
(e.g. '--concurrency=16 some-regex')

Change-Id: I8e8ab558ca35e7265aef55b96ade5159520b75a2
2018-10-10 02:49:38 +00:00
Jeremy Stanley 29a3bae7ac Clean up .gitignore references to personal tools
Developers run all sorts of different tools within Git repositories,
any of which can leave their own special trashfiles all over the
place. We can't every hope to catalog them all, so better to
recommend developers simply configure a global core.excludesfile to
filter the irrelevant files which tend to get created by their
personal choice of tools.

To this end, remove the long-standing sections for "Mr Developer"
and "Editors" since their mere existence here sends the signal that
we welcome (and have time to review) additions for any old tool
someone ever might happen to try. Also add a comment block
explaining this, for clarity.

We can, and should of course, continue to list files created by the
tools recommended by our workflow (test frameworks called from tox,
documentation and packaging builds, et cetera).

This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7
from the openstack-dev/cookiecutter repository.

Change-Id: I1b41efac219fca44e2548fc36633724d0ecfc0cb
2018-10-05 17:43:14 +00:00
Ben Nemec 33c099959a Modernize tox.ini
The -constraints environments are no longer needed, constraints are
the default configuration. Also update the envlist to reflect the
currently supported jobs.

Change-Id: I98d28ababca8d2ea848e0499d3abe6c46fe6df05
2018-09-21 18:28:15 +00:00
Ben Nemec 628dd03a0b Use sphinx-build for all docs venvs
One was apparently missed so it was still using setup.py build_sphinx.

Change-Id: I1337a67c5244c7c370beb03dfef1806c8dec709f
2018-09-19 19:49:38 +00:00
Ben Nemec 24fffaf712 Migrate to stestr
Since we're touching the coverage jobs, also fix the coverage
configuration.

Change-Id: I04d3da810c8a10c9d5a04b456d8bef10fc4f798f
2018-09-13 16:28:11 +00:00
Adam Spiers 61a80f07ac make tox docs environment follow PTI guidelines for sphinx build
https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
says:

    Note:

    We strongly discourage project teams from adding commands to the
    docs environment beyond:

        sphinx-build -W -b html doc/source doc/build/html

Discussion on #openstack-doc prompted the suggestion to adjust the
cookiecutter templates accordingly:

http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2018-08-09.log.html#t2018-08-09T16:04:54

Also update requirements.txt.

Change-Id: I8f23c82405692e9984ed1089fa44ac25cbc27aeb
2018-08-09 18:57:29 +01:00
Ben Nemec 219a12ae70 Update links
Some of the links in the templates were out of date.

Change-Id: I2d677f00981837147a8a1d5c211d02cc50aafe24
2018-06-15 21:22:19 +00:00
Nguyen Hung Phuong c7e47baf4a Remove pbr warnerrors in favor of sphinx check
This change removes the now unused "warnerrors" setting, which is
replaced by "warning-is-error" in sphinx releases >= 1.5 [1].

[1] http://lists.openstack.org/pipermail/openstack-dev/ 2017-March/113085.html

Change-Id: I93531c668cb64cd5fe0feb9ea3c1a605934aa999
Closes-Bug:#1693670
2018-02-05 01:16:35 +00:00
Andreas Jaeger 28e5985403 Move tox job in-tree
move legacy job legacy-oslo-cookiecutter-tox-cookiecutter in-tree and
convert it directly to Zuul v3.

Change-Id: I1ca853bdaf1e5c7088520ac913eff8cc258a4f34
2018-01-28 11:44:33 +01:00
ChangBo Guo(gcb) dc3a493176 Don't use oslo-incubator stuff any more
Change-Id: I46728e40e416bb532b86e2fc29361434fdee1296
2016-05-11 15:51:04 +08:00
ChangBo Guo(gcb) 13b0aa19a2 Remove unused file openstack-common.conf
Change-Id: Ic9a17853e01eb04de4ebedce559a0efe7c3b0106
2016-01-04 23:58:25 +08:00
Doug Hellmann 953e5e8792 remove python 2.6 trove classifier
OpenStack projects are no longer being tested under Python 2.6, so
remove the trove classifier implying that this project supports 2.6.

Change-Id: I470964a94fecde708eca3cedb91fb95f54b841f9
2015-12-23 13:21:54 +00:00
Jenkins 41d927fdc2 Merge "Remove MANIFEST.in" 2015-12-10 12:43:24 +00:00
Yuriy Taraday 08b8ee0fc1 Remove MANIFEST.in
It should not be needed for basic oslo project since pbr does the right
thing for it.

Change-Id: Ia256f517d212452bea57208ba806bcc09e95e9e9
2015-12-10 10:29:51 +03:00
Robert Collins 5ccc848904 Update tox.ini from cookiecutter changes.
- we can use usedevelop now
- use constraints
- AFAICT we don't need the hacking exception now

Change-Id: I7b6976fe6858487ca7eee323ea93b8ca4bb1aa5c
2015-12-10 16:50:11 +13:00
Jeremy Stanley c68991e4a2 Change ignore-errors to ignore_errors
Needed for coverage 4.0

Change-Id: I6cd9c3fbed7be328283064df2b4721ad568109fb
Co-Authored-By: Monty Taylor <mordred@inaugust.com>
2015-09-21 21:08:22 +00:00
Louis Taylor dafa136915 Remove executable bit and shebang from setup.py
Per discussions in this thread, the default should be -x without
the shebang:

    http://lists.openstack.org/pipermail/openstack-dev/2015-June/067323.html

Change-Id: I3f1046e1416890d9058c1c0e06df46f53f57f62e
2015-07-04 02:11:20 +01:00