Commit Graph

135 Commits

Author SHA1 Message Date
patchback[bot]
7198e20102 update the pip-compile details in the readme (#2472) (#2479)
- Remove outdated info about Python 3.10
- Add example of updating a single package

(cherry picked from commit ef4fe42bbb)

Co-authored-by: Don Naro <dnaro@redhat.com>
2025-03-27 11:56:14 +00:00
Maxwell G
107a3c4383 nox: add actionlint to lint Github Actions workflows
This PR integrates [actionlint](https://github.com/rhysd/actionlint)
into our CI pipeline to check our Github Actions for best practices and
common errors.
2024-09-17 14:55:12 -05:00
Lyle McKarns
be4c7259aa Issue #1633 nox session for tagging (#1649)
* WIP tagger session for nox

* First pass tagging nox session

* Formatting fixup

* Adding removal of tmpdir as per discussion

* tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one.

* isort fixup

* Working out suggested changes.

* Linting cleanup on changes

* Different approach to noted chagnes

* Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone

* Staging deletion per discussion

* Adding tag session to dependency update job

* after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts.

* Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that.

* I think this is where the call needed added to get the tags dependencies automatically updated

* remove gitpython, add tag.txt, add blank line

* Comment cleanup per OraNod

* doc README: document nox tag session instead of manual mode

* Update tests/typing.in

Per suggestion from @webnjaz

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>

---------

Co-authored-by: Maxwell G <maxwell@gtmx.me>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
2024-07-23 15:15:34 -05:00
Lyle McKarns
19119d022b Add tagger section to README per 1272 (#1460)
* First pass at adding tagging doc

* Further Doc Cleanup

* Add Details

* Update README.md

Markdown standards fixup

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

wording fixup

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Clearer description for why/when to tag

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

language clarity fixup

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

silly typo fixup

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

clarity fixup

Co-authored-by: Don Naro <dnaro@redhat.com>

* For clarity on venv, and reqs

* clarity on remotes for tagger

* Markdown quality fixup

* clarify checkout instructions for tagging

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

typo

Co-authored-by: Don Naro <dnaro@redhat.com>

* Fixups

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Don Naro <dnaro@redhat.com>

* Update README.md

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Update README.md

Co-authored-by: Sandra McCann <samccann@redhat.com>

* Cleanup of checkout directory description for clarity

* Update README.md

Co-authored-by: Maxwell G <maxwell@gtmx.me>

* Update README.md

Co-authored-by: Maxwell G <maxwell@gtmx.me>

* Update README.md

Co-authored-by: Maxwell G <maxwell@gtmx.me>

* Updates for clarity around use of the tagger script (fewer steps needed)

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Maxwell G <maxwell@gtmx.me>
2024-05-22 15:46:51 -04:00
Maxwell G
57764782a1 README: consistently use nox -s over nox -e (#923)
Some examples use `nox -s` and others use `nox -e`. `-e` and `-s` are
aliases, but we should stick to one for consistency.
2023-12-04 15:17:06 -05:00
Maxwell G
e952dd4365 nox pip-compile: allow passing --no-upgrade flag (#883)
* nox pip-compile: allow passing --no-upgrade flag

This allows running `nox -e pip-compile -- --no-upgrade` to make sure
that the requirements.txt files are in sync with the .in files but not
updating any other transitive dependency.

* README: make "## Updating dependencies" more concise

Co-authored-by: Don Naro <dnaro@redhat.com>

---------

Co-authored-by: Don Naro <dnaro@redhat.com>
2023-12-04 13:05:59 -06:00
Maxwell G
352c8e9e47 improve nox make session docs
Co-authored-by: Don Naro <dnaro@redhat.com>
2023-12-04 14:38:55 +00:00
Maxwell G
696286e0fc README: declare bash syntax for codeblocks 2023-12-01 17:37:31 +00:00
Maxwell G
554b35644e README.md: document the nox make session 2023-12-01 17:37:31 +00:00
Maxwell G
30f0a7c080 README: document Dependency files and PINNED envvar
This documents the way dependency files are organized and handled by
nox.

Co-authored-by: Don Naro <dnaro@redhat.com>
2023-10-26 14:51:28 +00:00
Don Naro
5a74e2f0eb README: document new nox sessions
Co-authored-by: Maxwell G <maxwell@gtmx.me>
2023-10-26 02:12:35 +00:00
Don Naro
2f8810b255 Add RST spellcheck (#524)
* Add docs spelling check
* Add codespell config to noxfile and ci
* Update README with details on spelling checks

Co-authored-by: Maxwell G <9920591+gotmax23@users.noreply.github.com>
2023-10-16 14:18:28 -04:00
Felix Fontein
b9323fbe54 Document how to bump dependencies (#446)
* Document how to bump dependencies.

* Drop `-i`, keep `-t`.

* Expand option names.

* Place command in code block.

* Adjust command.

Co-authored-by: Maxwell G <maxwell@gtmx.me>

---------

Co-authored-by: Maxwell G <maxwell@gtmx.me>
2023-10-15 14:34:02 -05:00
Michelle McCausland
0bc0a653c5 issue-457: Update all occurrences of Ansible core to Ansible Core (#471) 2023-10-02 11:10:53 -04:00
Don Naro
c0ce8de342 Add docs build steps to README (#37) 2023-07-03 12:40:57 +01:00
Sandra McCann
4d6dd38906 Update README.md 2023-06-26 12:06:11 -04:00
Sandra McCann
99343d507b Create README.md 2023-06-26 11:29:06 -04:00
Stephen Weber
7afa34ae8a Convert README from Markdown to ReStructured Text and use as longdesc (#22330)
* Convert README from Markdown to ReStructured Text and use as longdesc

Discussion in #13758 led to deciding to switch README to rst and having
setup.py consume it as the long_description.

* Fix long string in setup.py for pep8 compliance

* Open README.rst as read-only

* Update usages of root README.md to README.rst

Unsure about the file ./packaging/debian/docs as it (only) contains the
text README.md. I believe it's referencing ./packaging/debian/README.md
but maybe someone who knows debian packaging could review it?

* Pick up fixes that had been merged into README.md after the initial conversion to rst
2018-04-06 12:38:40 -07:00
Robert Wilkins III
798cd41b34 Update README.md (#35241)
Added a dash between "zero" and "downtime" on line 8 to match formatting previously used in the same line.
2018-01-24 11:37:43 +00:00
Matt Davis
ed0c2678cc devel usage README update (#30369)
* devel usage README update

* Update README.md

* Update README.md

* Update README.md
2017-09-14 10:48:58 -07:00
Dag Wieers
3add156a02 Fixes to the README 2017-09-14 16:28:39 +02:00
Dag Wieers
4fb283a4e3 Fix installation instructions link in the README (#24754)
* Fix the installation instructions link in the README

The original linked page (Getting started) assumed the user already had an installed system, which clearly was not the intention of the link.
So I replaced it with a link to the installation instructions, and removed the quick advice. The installation instructions are well structured and complete.

* Change to https

Links to ansible.com should end up over https
Seem to be missing the http -> https redirect from the docs site, I'll poke someone about that
2017-05-18 08:09:53 +01:00
Matt Clay
bea8a3201d Remove obsolete files and instructions. (#19079)
* Remove obsolete `unify_repos.sh` script.
* Remove submodule update after checkout reference.
2016-12-09 12:42:29 -05:00
John R Barker
6c4f365e67 No more submodules (#18776) 2016-12-08 11:35:19 -05:00
Valentin
710ede41ee Add link to licence file (COPYING) in README (#18521)
* Add link to licence file (COPYING) in README

* Update link
2016-11-19 01:03:51 -08:00
Robin Roth
fafcbf173c Change all links in readme to https
Fixes #17954
2016-10-24 09:49:23 -07:00
Benjamin Schwarze
d82808a1b0 Remove download stats badge (#16358)
PyPI download stats have been disabled due to resource constraints (see Donald Stufft's comment, https://bitbucket.org/pypa/pypi/issues/396/download-stats-have-stopped-working-again#comment-27808922).

Thus the download stats badge counter does not show correct data.
2016-06-20 10:14:37 -04:00
Matt Clay
1eab7e117c Remove travis build status badge from README.md. 2016-06-07 08:02:52 -07:00
Matt Clay
497459246a Add shippable build status badge to README.md. 2016-06-07 00:43:42 -07:00
Chris Meyers
8d500215b6 trigger jenkins integration tests 2015-12-08 10:03:20 -05:00
A. Lloyd Flanagan
6cba303035 Update README.md
Clarify release naming policy pre-2.0.
2015-10-17 09:38:35 -04:00
Jeff Geerling
76bd9e9239 Releases are now named after Led Zeppelin songs as of 2.0.0. 2015-09-29 16:28:17 -05:00
James Cammarata
90591782d6 Merge pull request #11869 from charleswhchan/devel
Update README.md
2015-08-06 07:22:13 -04:00
Charles Chan
3df35c293b Update README.md
Reformat commands to code format to make it stand out.
2015-08-05 21:15:49 -07:00
Charles Chan
1f899e92d1 Update README.md
Fix missing download badge. Link to shields.io.
2015-08-05 21:08:16 -07:00
Brian Coca
29347ac457 switched from png to svg
fixes #9885
2015-07-29 11:25:42 -04:00
Artur Cygan
312e79ccd5 Update README.md
There are over 1000 contributors now :)
2015-06-10 15:42:30 +02:00
James Laska
f451974efe Use correct URL for travis status badge
This uses the `devel` branch when displaying the travis-ci status badge.
2015-03-13 10:56:30 -04:00
James Laska
3d67e9e0c0 Add tox and travis-ci support
Add tox integration to run unittests in supported python releases.
Travis-CI is used for test execution.

Additionally, the unittest TestQuotePgIdentifier was updated to support
using assert_raises_regexp on python-2.6.

Sample travis-ci output available at
https://travis-ci.org/ansible/ansible/builds/54189977
2015-03-13 08:20:24 -04:00
Michael DeHaan
4fb7c1bff4 Set email to my personal address, thanks everyone!
http://michaeldehaan.net/post/109595670406/happy-trails-ansible
2015-01-30 17:28:37 -05:00
Michael DeHaan
662c63f1a0 Update contributor info in README 2014-11-18 18:42:55 -05:00
Sebastian Gumprich
90614283c4 Fixed 404-link for Michael DeHaan profile page. 2014-11-09 18:03:59 +00:00
Michael DeHaan
0354d19f73 Update README.md 2014-09-28 15:24:44 -04:00
Michael DeHaan
56b90390f4 Update README.md 2014-09-28 15:22:33 -04:00
Nitin Madhok
07287a2eaa Update README.md 2014-09-28 08:21:04 -04:00
Michael DeHaan
16c4c378bd README update 2014-09-26 17:56:21 -04:00
freshlikeesch
296d33d2d6 Formation, Format, and Constiency
There should be a period after "Various release-X.Y branches exist for previous releases". It should read "Various release-X.Y branches exist for previous releases." This should keep the Branch Info listings consistent.
2014-08-28 13:25:24 -04:00
Greg DeKoenigsberg
e2209670f7 Increase number of contributors in README 2014-08-25 14:04:53 -04:00
Michael DeHaan
2e9cfaaba3 Update README.md 2014-06-06 09:24:33 -04:00
Michael DeHaan
31cf5b39f0 Update README.md
formatting
2014-04-03 08:25:26 -04:00