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.

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

Build tasks: Rename compile to build:app #3371

Merged
merged 4 commits into from
Mar 22, 2023
Merged

Build tasks: Rename compile to build:app #3371

merged 4 commits into from
Mar 22, 2023

Conversation

colinrotherham
Copy link
Contributor

@colinrotherham colinrotherham commented Mar 9, 2023

We've planned to remove --destination flag to simplify our build tasks in:

But we currently have one build script that has some overlap:

npx gulp compile
npx gulp build:package --destination "package"
npx gulp build:dist --destination "dist"

Surprise: The compile task is also run on build:dist and unnecessarily generates documentation

Changes

This PR does three things:

  1. Renames Gulp compile task to build:app (the review app)
  2. Renames npm build:compile script to build:app
  3. Prevents build:dist from building JSDoc and SassDoc

This lines up all our tasks so we can remove --destination in future

Before

npx gulp compile

After

npx gulp build:app --destination "public"

@colinrotherham colinrotherham requested a review from a team as a code owner March 9, 2023 17:20
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 9, 2023 17:20 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 9, 2023 17:21 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 9, 2023 17:30 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 9, 2023 19:32 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 9, 2023 19:43 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 10, 2023 16:40 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 13, 2023 14:02 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 15, 2023 09:27 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 15, 2023 10:12 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 17, 2023 11:24 Inactive
Base automatically changed from build-paths to main March 17, 2023 13:15
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 20, 2023 13:43 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 21, 2023 15:45 Inactive
@colinrotherham colinrotherham changed the title Build tasks: Rename compile to build:public Build tasks: Rename compile to build:app Mar 22, 2023
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 22, 2023 09:54 Inactive
Copy link
Contributor

@36degrees 36degrees left a comment

Choose a reason for hiding this comment

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

Looks good, bar one minor comment on some of the docs changes

Comment on lines 39 to 40
- run sub tasks from `gulp styles` without ESLint code quality checks
- run sub tasks from `gulp scripts` without StyleLint code quality checks
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these the wrong way round?

Suggested change
- run sub tasks from `gulp styles` without ESLint code quality checks
- run sub tasks from `gulp scripts` without StyleLint code quality checks
- run sub tasks from `gulp styles` without StyleLint code quality checks
- run sub tasks from `gulp scripts` without ESLint code quality checks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@36degrees Well spotted, they've been switched since 4c11f65 🤦‍♂️

✅ Fixed

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 22, 2023 10:36 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-3371 March 22, 2023 10:40 Inactive
@colinrotherham colinrotherham merged commit 8c668ce into main Mar 22, 2023
@colinrotherham colinrotherham deleted the build-tasks branch March 22, 2023 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants