External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-11 14:39:30 -02:30
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source 
* Update filename changes where appropriate (s/awx/ansible-tower/)
* Updates related to recent `setup_tarball` changes
* More updates needed to reflect current rpm and deb build process
This commit is contained in:
James Laska
2014-11-19 10:41:38 -05:00
parent ee13723399
commit b1cd745800
1 changed files with 24 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/build_system.md
View File

@@ -11,26 +11,31 @@ Packaging Details
### Version and Release Determination ### ### Version and Release Determination ###
The VERSION and RELEASE variables used by the build process are configured The `VERSION` and `RELEASE` variables used by the build process are configured
in the Makefile, and are based on the `__version__` field contained within in the Makefile. The `VERSION` is taken from the `__version__` field contained
the `awx/__init__.py file.` This string should always be of the format: within the `awx/__init__.py file.` This string should always be of the format:
version-release [0-9\.]+
There should only be one "-" contained in the string. (Which can represent There should *not* be any "-" characters contained in the string. (Which can
a build/rev type release number). Example: represent a build/rev type release number). Example:
1.2.2-0 1.2.2
The RELEASE value is generated by the Makefile during build time. While the
value can be supplied by setting the environment variable `RELEASE`, it is
recommended to let the `Makefile` determine the appropriate value.
### OFFICIAL vs. Non-OFFICIAL Builds ### ### OFFICIAL vs. Non-OFFICIAL Builds ###
An "official" build is one that does not include a development timestamp An "official" build is one that does not include a development timestamp in the
in the release field. This is controlled by setting the environment variable release field. This is controlled by setting the environment variable
`OFFICIAL=yes` prior to running the make command. `OFFICIAL=yes` prior to running the make command.
Non-official builds will replace the `RELEASE` variable with the following string: Non-official builds will replace the `RELEASE` variable with the following
string:
-devYYYYmmDDHHMM -0.gitYYYYmmDDHHMM
Non-official builds should only be used for development purposes, and are Non-official builds should only be used for development purposes, and are
copied into the nightly repos. Official builds will be copied out to the copied into the nightly repos. Official builds will be copied out to the
@@ -48,21 +53,21 @@ is handled by the function `sdist_awx()` in `setup.py`.
The resulting tar.gz file will be named: The resulting tar.gz file will be named:
awx-${VERSION}-${RELEASE}.tar.gz ansible-tower-${VERSION}-${RELEASE}.tar.gz
### RPM Build Process ### ### RPM Build Process ###
The first step of the RPM build process is to remove the `$RELEASE` from the The first step of the RPM build process is to remove the `$RELEASE` from the
tar.gz, since the spec file does not like to include the release. This is tar.gz, since the spec file does not like to include the release. This is
handled by the `rpmtar` Makefile target, which first unpacks the file, renames handled by the `rpmtar` Makefile target, which first unpacks the file, renames
the contained awx directory to simply be `awx-${VERSION}`, and finally re- the contained directory to simply be `ansible-tower-${VERSION}`, and finally re-
packages the file as `awx-${VERSION}.tar.gz`. packages the file as `ansible-tower-${VERSION}.tar.gz`.
The main Makefile target for the rpm build is (unsurprisingly) `rpm`. This copies The main Makefile target for the rpm build is (unsurprisingly) `rpm`. This copies
the re-formed sdist .tar.gz file into the rpm-build directory and then calls the re-formed sdist .tar.gz file into the rpm-build directory and then calls
the rpmbuild command to create the RPM. the rpmbuild command to create the RPM.
The spec file for this command is `packaging/rpm/awx.spec`. This file is currently The spec file for this command is `packaging/rpm/ansible-tower.spec`. This file is currently
maintained by hand, so any changelog entries must be added to it manually. All maintained by hand, so any changelog entries must be added to it manually. All
other aspects of the file (source, version, release, etc.) are picked up via other aspects of the file (source, version, release, etc.) are picked up via
variables that are set by the Makefile and do not need to be updated during variables that are set by the Makefile and do not need to be updated during
@@ -74,16 +79,16 @@ The process to build a .deb is somewhat more involved, and I will not get too
involved in the specifics of how the debian packaging works. The main files used involved in the specifics of how the debian packaging works. The main files used
in this packaging are (all found in `packaging/deb/`): in this packaging are (all found in `packaging/deb/`):
- awx.dirs - ansible-tower.dirs
- awx.install - ansible-tower.install
- control - control
- rules - rules
- {pre,post}{inst,rm} - {pre,post}{inst,rm}
The `awx.dirs` file contains the directories (listed as paths relative to the The `ansible-tower.dirs` file contains the directories (listed as paths relative to the
build root) that will be created during the packaging. build root) that will be created during the packaging.
The `awx.install` file contains a list of files that will be installed directly The `ansible-tower.install` file contains a list of files that will be installed directly
by the build process rather than via the `make install` command or other steps. This by the build process rather than via the `make install` command or other steps. This
is of the format "source destination" (where the destination is also a path is of the format "source destination" (where the destination is also a path
relative to the build root). relative to the build root).