https://github.com/garronej/automatic-octo-adventure
https://github.com/garronej/automatic-octo-adventure
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/garronej/automatic-octo-adventure
- Owner: garronej
- License: mit
- Created: 2023-02-25T12:25:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-25T13:30:35.000Z (over 2 years ago)
- Last Synced: 2025-02-05T11:18:49.316Z (4 months ago)
- Language: TypeScript
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Install / Import
```bash
$ npm install --save automatic-octo-adventure
```
```typescript
import { myFunction, myObject } from "automatic-octo-adventure";
```
Specific imports:
```typescript
import { myFunction } from "automatic-octo-adventure/myFunction";
import { myObject } from "automatic-octo-adventure/myObject";
```
# Contributing
## Testing your changes in an external app
You have made some changes to the code and you want to test them
in your app before submitting a pull request?
Assuming `you/my-app` have `automatic-octo-adventure` as a dependency.
```bash
cd ~/github
git clone https://github.com/you/my-app
cd my-app
yarn
cd ~/github
git clone https://github.com/garronej/automatic-octo-adventure
cd automatic-octo-adventure
yarn
yarn build
yarn link-in-app my-app
npx tsc -w
# Open another terminal
cd ~/github/my-app
rm -rf node_modules/.cache
yarn start # Or whatever my-app is using for starting the project
```
You don't have to use `~/github` as reference path. Just make sure `my-app` and `automatic-octo-adventure`
are in the same directory.
> Note for the maintainer: You might run into issues if you do not list all your singleton dependencies in
> `src/link-in-app.js -> singletonDependencies`. A singleton dependency is a dependency that can
> only be present once in an App. Singleton dependencies are usually listed as peerDependencies example `react`, `@emotion/*`.
## Releasing
For releasing a new version on GitHub and NPM you don't need to create a tag.
Just update the `package.json` version number and push.
For publishing a release candidate update your `package.json` with `1.3.4-rc.0` (`.1`, `.2`, ...).
It also work if you do it from a branch that have an open PR on main.
> Make sure your have defined the `NPM_TOKEN` repository secret or NPM publishing will fail.