summary |
shortlog |
log |
commit | commitdiff |
review |
tree
raw |
patch |
inline | side by side (from parent 1:
60508d5)
Extend lf_tox_sonar with parameters macro lf-infra-maven-parameters
so job definitions can configure mvn-opts, mvn-params and mvn-version
values. Default values are defined so existing jobs are not affected.
This change makes the python-tox sonar template consistent with the
maven sonar template.
Extend the PyPI package structure recommendation with a way to share
the docs/ folder.
Change-Id: I2f785cabc9058238d36505c8b4af8f87114a685a
Issue-Id: RELENG-2677
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
file change such as documentation, because the job cannot upload the
same package twice.
file change such as documentation, because the job cannot upload the
same package twice.
+To make the document files available for building a Python package
+long description in setup.py, add a symbolic link "docs" in the
+package subdirectory pointing to the top-level docs directory.
+
.. code-block:: bash
git-repo-name/
│
├── docs/
.. code-block:: bash
git-repo-name/
│
├── docs/
+ │ ├── index.rst
+ │ └── release-notes.rst
│
├── helloworld-package/
│ │
│
├── helloworld-package/
│ │
-Use of these templates requires a .pypirc configuration file in the
-Jenkins builder home directory. An example appears next that uses API
-tokens. Note that in the [pypi] entry the repository key-value pair is
-optional, it defaults to pypi.org.
+Jobs built from the PyPI templates depend on a .pypirc configuration file
+in the Jenkins builder home directory. An example appears next that uses
+API tokens. Note that in the [pypi] entry the repository key-value pair
+is optional, it defaults to pypi.org.
:build-node: The node to run the build on.
:jenkins-ssh-credential: Credential to use for SSH. (Generally set
in defaults.yaml)
:build-node: The node to run the build on.
:jenkins-ssh-credential: Credential to use for SSH. (Generally set
in defaults.yaml)
+ :mvn-settings: The settings file with credentials for the project
:project: Git repository name
:project-name: Jenkins job name prefix
:project: Git repository name
:project-name: Jenkins job name prefix
:disable-job: Whether to disable the job (default: false)
:dist-binary: Whether to build a binary wheel distribution. (default: true)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:disable-job: Whether to disable the job (default: false)
:dist-binary: Whether to build a binary wheel distribution. (default: true)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
+ :mvn-params: Parameters to pass to the mvn CLI. (default: '')
+ :mvn-version: Version of maven to use. (default: mvn35)
:parallel: Boolean indicator for tox to run tests in parallel or series.
(default: false, in series)
:pre-build-script: Shell script to execute before the tox builder. For
:parallel: Boolean indicator for tox to run tests in parallel or series.
(default: false, in series)
:pre-build-script: Shell script to execute before the tox builder. For
:build-node: The node to run the build on.
:jenkins-ssh-credential: Credential to use for SSH. (Generally set
in defaults.yaml)
:build-node: The node to run the build on.
:jenkins-ssh-credential: Credential to use for SSH. (Generally set
in defaults.yaml)
+ :mvn-settings: The settings file with credentials for the project
:project: Git repository name
:project-name: Jenkins job name prefix
:project: Git repository name
:project-name: Jenkins job name prefix
:disable-job: Whether to disable the job (default: false)
:dist-binary: Whether to build a binary wheel distribution. (default: true)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:disable-job: Whether to disable the job (default: false)
:dist-binary: Whether to build a binary wheel distribution. (default: true)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+ :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
+ :mvn-params: Parameters to pass to the mvn CLI. (default: '')
+ :mvn-version: Version of maven to use. (default: mvn35)
:parallel: Boolean indicator for tox to run tests in parallel or series.
(default: false, in series)
:pre-build-script: Shell script to execute before the tox builder. For
:parallel: Boolean indicator for tox to run tests in parallel or series.
(default: false, in series)
:pre-build-script: Shell script to execute before the tox builder. For
#########################
- lf_tox_sonar: &lf_tox_sonar
#########################
- lf_tox_sonar: &lf_tox_sonar
######################
# Default parameters #
######################
# Default parameters #
java-version: openjdk8
mvn-global-settings: global-settings
mvn-goals: validate
java-version: openjdk8
mvn-global-settings: global-settings
mvn-goals: validate
+ mvn-opts: ""
+ mvn-params: ""
mvn-settings: "{mvn-settings}"
mvn-version: mvn35
parallel: true
mvn-settings: "{mvn-settings}"
mvn-version: mvn35
parallel: true
project: "{project}"
branch: "{branch}"
stream: "{stream}"
project: "{project}"
branch: "{branch}"
stream: "{stream}"
+ - lf-infra-maven-parameters:
+ mvn-opts: "{mvn-opts}"
+ mvn-params: "{mvn-params}"
+ mvn-version: "{mvn-version}"
- lf-infra-tox-parameters:
tox-dir: "{tox-dir}"
tox-envs: "{tox-envs}"
- lf-infra-tox-parameters:
tox-dir: "{tox-dir}"
tox-envs: "{tox-envs}"
--- /dev/null
+---
+fixes:
+ - |
+ Extend macro lf_tox_sonar with parameters macro lf-infra-maven-parameters
+ so job definitions can configure mvn-opts, mvn-params and mvn-version
+ values. Default values are defined so existing jobs are not affected.
+ This change makes the python-tox sonar template consistent with the
+ maven sonar template.
+
+ Extend the PyPI package structure recommendation with a way to share
+ the docs/ folder.