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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update hacking to dotrun #4587

Merged
merged 2 commits into from
Oct 17, 2022
Merged

Update hacking to dotrun #4587

merged 2 commits into from
Oct 17, 2022

Conversation

huwshimi
Copy link
Contributor

@huwshimi huwshimi commented Oct 13, 2022

Done

  • Replace ./run instructions with dotrun

Fixes: #4576.

QA

n/a

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 馃巵, Breaking Change 馃挘, Bug 馃悰, Documentation 馃摑, Maintenance 馃敤.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix relesase (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.
  • Documentation side navigation should be updated with the relevant labels.

@huwshimi huwshimi added Review: Code needed Documentation 馃摑 Documentation changes or updates labels Oct 13, 2022
@webteam-app
Copy link

Demo starting at https://vanilla-framework-4587.demos.haus

@@ -32,21 +32,21 @@ When writing SCSS, it's useful to run both commands in separate terminals so cha

### Via Docker

It can also be run on other operating systems by first [installing Docker](https://docs.docker.com/engine/installation/) (Linux users may need to [add your user to the `docker` group](https://docs.docker.com/engine/installation/linux/linux-postinstall/)), and then using the `./run` script:
It can also be run on other operating systems by first [installing Docker](https://docs.docker.com/engine/installation/) (Linux users may need to [add your user to the `docker` group](https://docs.docker.com/engine/installation/linux/linux-postinstall/)) and then [installing dotrun](https://github.com/canonical/dotrun#installation):
Copy link
Contributor

Choose a reason for hiding this comment

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

The section above is Via dotrun and is currently practically a duplicate. Running via dotrun requires docker.
So I think they should be merged.

Also the section above mentions "dotrun snap" - it's not a snap anymore, so we should not call it that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah good idea! I've merged them.

# Sass files and build automatically:
./run watch
# See a full list of commands:
dotrun exec yarn run --non-interactive
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've suggested this as a feature of dotrun: canonical/dotrun#106.

@bartaz bartaz merged commit ee8441c into canonical:main Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 馃摑 Documentation changes or updates Review: Code +1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated instructions in HACKING.md
3 participants