Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/archetypes
Collection of Maven archetypes to get developers started
https://github.com/jenkinsci/archetypes
hacktoberfest
Last synced: 3 months ago
JSON representation
Collection of Maven archetypes to get developers started
- Host: GitHub
- URL: https://github.com/jenkinsci/archetypes
- Owner: jenkinsci
- Created: 2017-09-01T17:51:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T00:21:08.000Z (7 months ago)
- Last Synced: 2024-04-10T03:58:39.409Z (7 months ago)
- Topics: hacktoberfest
- Language: Java
- Homepage:
- Size: 897 KB
- Stars: 62
- Watchers: 20
- Forks: 46
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
Maven archetypes to help you create new components involving Jenkins, such as plugins.
[](https://github.com/jenkinsci/archetypes/releases/latest)
## Usage
To see all currently released archetypes and pick one to instantiate:
```sh
mvn archetype:generate -Dfilter=io.jenkins.archetypes:
```
It is also possible to run this noninteractively:
```sh
mvn archetype:generate -B -DarchetypeGroupId=io.jenkins.archetypes -DarchetypeArtifactId=empty-plugin -DhostOnJenkinsGitHub=true -DarchetypeVersion=1.20 -DartifactId=somefeature
```
In olden times, people used `mvn hpi:create` or even a web-based tool to create new plugins.
This has been deprecated in favor of the new archetypes, which cover more scenarios and require no special tooling.
The NetBeans IDE also offers a [plugin for Jenkins development](https://github.com/stapler/netbeans-stapler-plugin/blob/master/README.md) which offers a Jenkins plugin archetype via the **File » New Project** wizard.
If you have defined a mirror like this in your `settings.xml` you might _not_ be able to use filter option as described above.
```xml
repo.jenkins-ci.org-all
https://repo.jenkins-ci.org/public
*,!central
```
## Changes
See [GitHub Releases](https://github.com/jenkinsci/archetypes/releases) for changes.
For older versions, see the [archive](https://github.com/jenkinsci/archetypes/blob/314ac1a0b753179a63fe8422ee4d2fae024a7df5/README.md#14-2018-mar-12).
## Development
To create a new archetype, file a pull request creating a new `module`, following the examples currently here. Important pieces:
* `pom.xml` must have `maven-archetype`
* should also have a ``
* `src/main/resources/META-INF/maven/archetype-metadata.xml` defines files and directories to be copied & processed
* `src/main/resources/archetype-resources/`: the template for the new component (remember a sample `.gitignore`)
* `src/test/resources/projects/testInstall/{goal.txt,archetype.properties}`: defines an integration test, proving that the archetype can not just be instantiated, but builds successfully thereafter
* if it should have our standard templates for `.gitignore`, `README.md`, etc., then copy the `maven-resources-plugin` config in `empty-plugin`
Archetypes are expected to use technologies hosted in @jenkinsci (or a few other places pulled in by Jenkins core, such as @stapler).
Other archetypes can be developed in a `profile` but will not be published.
Releasing:
```sh
mvn -B release:{prepare,perform}
```
In addition to needing write permission to this repository, you must have been preauthorized to deploy to the `io/jenkins/archetypes/` sector of OSSRH.
Artifacts will [appear on Maven Central](https://repo1.maven.org/maven2/io/jenkins/archetypes/) after a few minutes.
But as noted in OSSRH-34275, the catalog only gets regenerated weekly; to check it:
```sh
curl -s http://repo1.maven.org/maven2/archetype-catalog.xml | xmlstarlet sel -R -I -t -c '//archetype[groupId="io.jenkins.archetypes"]'
```
If testing their appearance, be sure to use a clean environment:
```sh
docker run -ti --rm --name mvn --entrypoint /bin/bash maven:3.8.3-jdk-8
```