Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support yarn.lock maintenance #105

Merged
merged 9 commits into from
Apr 13, 2017
Merged

Support yarn.lock maintenance #105

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
17acc52
Improve yarn logs
rarkins Feb 15, 2017
63a79be
Add processYarnLock
rarkins Feb 15, 2017
9808161
Update worker.js
rarkins Feb 21, 2017
c8cfaec
Update worker.js
rarkins Feb 21, 2017
0c9dd13
Fix and update docs
rarkins Mar 13, 2017
329a943
Merge branch 'master' into feature/96-yarn-maintenance
rarkins Apr 7, 2017
694bc5b
Make Yarn Maintenance strings into templates
rarkins Apr 7, 2017
d64aa15
Merge branch 'master' into feature/96-yarn-maintenance
rarkins Apr 13, 2017
f6727c1
Merge branch 'master' into feature/96-yarn-maintenance
rarkins Apr 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,24 +56,25 @@ $ node renovate --help

Options:

-h, --help output usage information
--enabled [boolean] Enable or disable renovate
--onboarding [boolean] Require a Configuration PR first
--platform <string> Platform type of repository
--endpoint <string> Custom endpoint to use
--token <string> Repository Auth Token
--package-files <list> Package file paths
--dep-types <list> Dependency types
--ignore-deps <list> Dependencies to ignore
--ignore-future [boolean] Ignore versions tagged as "future"
--ignore-unstable [boolean] Ignore versions with unstable semver
--respect-latest [boolean] Ignore versions newer than npm "latest" version
--recreate-closed [boolean] Recreate PRs even if same ones were closed previously
--rebase-stale-prs [boolean] Rebase stale PRs (GitHub only)
--labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--log-level <string> Logging level
-h, --help output usage information
--enabled [boolean] Enable or disable renovate
--onboarding [boolean] Require a Configuration PR first
--platform <string> Platform type of repository
--endpoint <string> Custom endpoint to use
--token <string> Repository Auth Token
--package-files <list> Package file paths
--dep-types <list> Dependency types
--ignore-deps <list> Dependencies to ignore
--ignore-future [boolean] Ignore versions tagged as "future"
--ignore-unstable [boolean] Ignore versions with unstable semver
--respect-latest [boolean] Ignore versions newer than npm "latest" version
--recreate-closed [boolean] Recreate PRs even if same ones were closed previously
--rebase-stale-prs [boolean] Rebase stale PRs (GitHub only)
--labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--maintain-yarn-lock [boolean] Keep yarn.lock updated in main branch (no monorepo support)
--log-level <string> Logging level

Examples:

Expand Down Expand Up @@ -126,4 +127,5 @@ Obviously, you can't set repository or package file location with this method.
| `labels` | Labels to add to Pull Request | list | `[]` | `RENOVATE_LABELS` | `--labels` |
| `assignees` | Assignees for Pull Request | list | `[]` | `RENOVATE_ASSIGNEES` | `--assignees` |
| `reviewers` | Requested reviewers for Pull Requests (GitHub only) | list | `[]` | `RENOVATE_REVIEWERS` | `--reviewers` |
| `maintainYarnLock` | Keep yarn.lock updated in main branch (no monorepo support) | boolean | `false` | `RENOVATE_MAINTAIN_YARN_LOCK` | `--maintain-yarn-lock` |
| `logLevel` | Logging level | string | `"info"` | `LOG_LEVEL` | `--log-level` |
7 changes: 7 additions & 0 deletions lib/config/definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,13 @@ const options = [
description: 'Requested reviewers for Pull Requests (GitHub only)',
type: 'list',
},
// Yarn options
{
name: 'maintainYarnLock',
description: 'Keep yarn.lock updated in main branch (no monorepo support)',
type: 'boolean',
default: false,
},
// Debug options
{
name: 'logLevel',
Expand Down
5 changes: 4 additions & 1 deletion lib/helpers/yarn.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ async function generateLockFile(newPackageJson, npmrcContent, yarnrcContent) {
if (yarnrcContent) {
fs.writeFileSync(path.join(tmpDir.name, '.yarnrc'), yarnrcContent);
}
cp.spawnSync('yarn', ['install'], { cwd: tmpDir.name });
logger.debug('Spawning yarn install');
const result = cp.spawnSync('yarn', ['install'], { cwd: tmpDir.name });
logger.debug(String(result.stdout));
logger.debug(String(result.stderr));
yarnLock = fs.readFileSync(path.join(tmpDir.name, 'yarn.lock'));
} catch (error) {
tmpDir.removeCallback();
Expand Down
29 changes: 29 additions & 0 deletions lib/worker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
const logger = require('winston');
const path = require('path');
const stringify = require('json-stringify-pretty-compact');
const githubApi = require('./api/github');
const gitlabApi = require('./api/gitlab');
Expand Down Expand Up @@ -54,10 +55,38 @@ async function processPackageFile(repoName, packageFile, packageConfig) {
// Find all upgrades for remaining dependencies
const upgrades = await findUpgrades(dependencies, config);
// Process all upgrades sequentially
if (config.maintainYarnLock) {
await maintainYarnLock(config);
}
await processUpgradesSequentially(config, upgrades);
logger.info(`${repoName} ${packageFile} done`);
}

async function maintainYarnLock(inputConfig) {
const packageContent = await inputConfig.api.getFileContent(inputConfig.packageFile);
const yarnLockFileName = path.join(path.dirname(inputConfig.packageFile), 'yarn.lock');
logger.debug(`Checking for ${yarnLockFileName}`);
const existingYarnLock = await inputConfig.api.getFileContent(yarnLockFileName);
if (!existingYarnLock) {
return;
}
logger.debug('Found existing yarn.lock file');
const newYarnLock = await branchWorker.getYarnLockFile(packageContent, inputConfig);
if (existingYarnLock === newYarnLock.contents) {
logger.debug('Yarn lock file does not need updating');
return;
}
logger.debug('Yarn lock needs updating');
const commitMessage = 'Renovate yarn.lock file';
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be added to the default definitions so that it can be configured by the project or renovate user? (We use Angular commit conventions for all our commits to help with other automation tooling)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good idea. I'm a little concerned about the "scalability" of too many message definitions, however that's not an excuse for making them hardcoded!

// API will know whether to create new branch or not
const params = Object.assign({}, inputConfig);
params.branchName = 'renovate/yarn-lock';
params.prTitle = 'Renovate yarn.lock file';
params.prBody = 'This PR regenerates yarn.lock files based on the existing `package.json` files.';
await inputConfig.api.commitFilesToBranch(params.branchName, [newYarnLock], commitMessage);
prWorker.ensurePr(params);
}

async function findUpgrades(dependencies, inputConfig) {
const allUpgrades = [];
// findDepUpgrades can add more than one upgrade to allUpgrades
Expand Down
37 changes: 19 additions & 18 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,25 @@ $ node renovate --help

Options:

-h, --help output usage information
--enabled [boolean] Enable or disable renovate
--onboarding [boolean] Require a Configuration PR first
--platform <string> Platform type of repository
--endpoint <string> Custom endpoint to use
--token <string> Repository Auth Token
--package-files <list> Package file paths
--dep-types <list> Dependency types
--ignore-deps <list> Dependencies to ignore
--ignore-future [boolean] Ignore versions tagged as "future"
--ignore-unstable [boolean] Ignore versions with unstable semver
--respect-latest [boolean] Ignore versions newer than npm "latest" version
--recreate-closed [boolean] Recreate PRs even if same ones were closed previously
--rebase-stale-prs [boolean] Rebase stale PRs (GitHub only)
--labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--log-level <string> Logging level
-h, --help output usage information
--enabled [boolean] Enable or disable renovate
--onboarding [boolean] Require a Configuration PR first
--platform <string> Platform type of repository
--endpoint <string> Custom endpoint to use
--token <string> Repository Auth Token
--package-files <list> Package file paths
--dep-types <list> Dependency types
--ignore-deps <list> Dependencies to ignore
--ignore-future [boolean] Ignore versions tagged as "future"
--ignore-unstable [boolean] Ignore versions with unstable semver
--respect-latest [boolean] Ignore versions newer than npm "latest" version
--recreate-closed [boolean] Recreate PRs even if same ones were closed previously
--rebase-stale-prs [boolean] Rebase stale PRs (GitHub only)
--labels <list> Labels to add to Pull Request
--assignees <list> Assignees for Pull Request
--reviewers <list> Requested reviewers for Pull Requests (GitHub only)
--maintain-yarn-lock [boolean] Keep yarn.lock updated in main branch (no monorepo support)
--log-level <string> Logging level

Examples:

Expand Down