Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 3.59 KB

README.md

File metadata and controls

75 lines (45 loc) · 3.59 KB
Raw

Atlassian fork of "frontend-maven-plugin"

license PRs Welcome

Intro

First read the upstream README

Purpose

There are a few changes that are not wanted upstream, but are useful to developing for Atlassian products

Goals

  • Make it as easy as possible to use without subverting expectations
  • Keep in sync with upstream
  • Upstream as much as possible

Issues, Contributing

Thank you for considering a contribution! Pull requests, issues and comments are welcome.

Please try to contribute upstream first. It maximises the value out of every change and keeps this fork easier to maintain. You can check upstream's issue tracker and pull requests to gauge maintainer opinion and avoid duplicate work.

Please minimise changes to the upstream code to keep syncing with upstream easy.

For pull requests, please:

  • Add tests for new features and bug fixes
  • Follow the existing style
  • Separate unrelated changes into multiple pull requests

See the existing issues for things to start contributing.

For bigger changes, please make sure you start a discussion first by creating an issue and explaining the intended change.

Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).

Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.

Releasing

Only Atlassians may release a new version, follow this guide.

Usage requirements

Usage guidance

Format of the Node version

It shouldn't matter if the v prefix is present, e.g. 14.8.0 and v14.8.0.

Old, non-standard, and codename versions are also supported if they're available, e.g. latest-v12.x.

Using Node version files

The plugin should automatically detect the version from files like: .node-version, .nvmrc, and .tool-versions. Comments in the files should be ignored. If the file is not in the working directory, nor any of the parent directories, it can be manually set in the configuration like so:

<plugin>
    <groupId>com.github.eirslett</groupId>
    <artifactId>frontend-maven-plugin</artifactId>
    <configuration>
        <nodeVersionFile>${project.basedir}/dotfiles/.nvmrc</nodeVersionFile>
    </configuration>
</plugin>

Cheers from Atlassian