Repo Maintenance / Prep Release (#775)

Co-authored-by: Jan Buschtöns <jan@buschtoens.me>
buschtoens · Jul 7, 2023 · 68c3273 · 68c3273
1 parent ef31735
commit 68c3273
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 161 deletions.
diff --git a/.dependabot/config.yml b/.dependabot/config.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -16,5 +16,6 @@ jobs:
         with:
           pnpm-args: --frozen-lockfile
       - run: npm publish
+        working-directory: ./ember-link
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,25 +1,39 @@
 # Changelog
 
+## v2.1.0 (2023-05-25)
+
+#### :house: Internal
+
+* [#746](https://github.com/buschtoens/ember-link/pull/746) Deprecations and TS Fixes ([@gossi](https://github.com/gossi))
+
+#### Committers: 1
+
+- Thomas Gossmann ([@gossi](https://github.com/gossi))
 
 ## v2.0.1 (2022-12-23)
 
 #### :bug: Bug Fix
+
 * [#718](https://github.com/buschtoens/ember-link/pull/718) Fix exporting `LinkParams` and `UILinkParams` types ([@bertdeblock](https://github.com/bertdeblock))
 
 #### :house: Internal
+
 * [#711](https://github.com/buschtoens/ember-link/pull/711) Update `.npmignore` file ([@Turbo87](https://github.com/Turbo87))
 
 #### Committers: 2
+
 - Bert De Block ([@bertdeblock](https://github.com/bertdeblock))
-- Tobias Bieniek ([@Turbo87](https://github.com/Turbo87))
+* Tobias Bieniek ([@Turbo87](https://github.com/Turbo87))
 
 ## v2.0.0 (2022-04-06)
 
 #### :boom: Breaking Change
+
 * [#658](https://github.com/buschtoens/ember-link/pull/658) Remove link cache ([@Turbo87](https://github.com/Turbo87))
 * [#656](https://github.com/buschtoens/ember-link/pull/656) Raise minimum Node to v12 ([@Turbo87](https://github.com/Turbo87))
 
 #### :house: Internal
+
 * [#678](https://github.com/buschtoens/ember-link/pull/678) Adjust `@glimmer/tracking` dependency to use semver ([@Turbo87](https://github.com/Turbo87))
 * [#675](https://github.com/buschtoens/ember-link/pull/675) Use `pnpm` package manager ([@Turbo87](https://github.com/Turbo87))
 * [#674](https://github.com/buschtoens/ember-link/pull/674) Release via CI ([@Turbo87](https://github.com/Turbo87))
@@ -33,43 +47,52 @@
 * [#618](https://github.com/buschtoens/ember-link/pull/618) Fix CI issues ([@Turbo87](https://github.com/Turbo87))
 
 #### Committers: 1
+
 - Tobias Bieniek ([@Turbo87](https://github.com/Turbo87))
 
 ## v1.3.1 (2021-01-29)
 
 #### :rocket: Enhancement
+
 * [#518](https://github.com/buschtoens/ember-link/pull/518) fix(link-manager): Use private router API to query `currentURL` in a side-effect-free way ([@Turbo87](https://github.com/Turbo87))
 
 #### Committers: 1
+
 - Tobias Bieniek ([@Turbo87](https://github.com/Turbo87))
 
 ## v1.3.0 (2021-01-28)
 
 #### :rocket: Enhancement
+
 * [#507](https://github.com/buschtoens/ember-link/pull/507) Fix Ember 3.24 compatibility ([@Turbo87](https://github.com/Turbo87))
 
 #### :bug: Bug Fix
+
 * [#506](https://github.com/buschtoens/ember-link/pull/506) services/link-manager: Fix typo in `getLinkParamsFromURL()` method name ([@Turbo87](https://github.com/Turbo87))
 
 #### :house: Internal
+
 * [#505](https://github.com/buschtoens/ember-link/pull/505) tests/components: Run tests with and without the `setupLink()` test helper ([@Turbo87](https://github.com/Turbo87))
 * [#504](https://github.com/buschtoens/ember-link/pull/504) Add `LinkTo` tests and `currentURL()` assertions ([@Turbo87](https://github.com/Turbo87))
 * [#503](https://github.com/buschtoens/ember-link/pull/503) tests/components/link: Add "incomplete model" test ([@Turbo87](https://github.com/Turbo87))
 * [#502](https://github.com/buschtoens/ember-link/pull/502) Adjust CI jobs ([@Turbo87](https://github.com/Turbo87))
 * [#501](https://github.com/buschtoens/ember-link/pull/501) tests/acceptance: Avoid multiple `Router.map()` calls ([@Turbo87](https://github.com/Turbo87))
 
 #### Committers: 1
+
 - Tobias Bieniek ([@Turbo87](https://github.com/Turbo87))
 
 ## v1.2.1 (2020-11-16)
 
 #### :bug: Bug Fix
+
 * [#473](https://github.com/buschtoens/ember-link/pull/473) Check `button` property and modifier key states before calling `preventDefault()` ([@Turbo87](https://github.com/Turbo87))
 
 #### Committers: 1
+
 - Tobias Bieniek ([@Turbo87](https://github.com/Turbo87))
 
 ## v1.2.0 (2020-08-06)
 
-- [#257](https://github.com/buschtoens/ember-link/issues/257) Testing API and support for render tests
-- [#394](https://github.com/buschtoens/ember-link/pull/394) fix(Link): Use `currentTransitionStack` to enable auto-tracking
+* [#257](https://github.com/buschtoens/ember-link/issues/257) Testing API and support for render tests
+* [#394](https://github.com/buschtoens/ember-link/pull/394) fix(Link): Use `currentTransitionStack` to enable auto-tracking
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1 @@
+ember-link/LICENSE.md
diff --git a/README.md b/README.md
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+ember-link/README.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -55,29 +55,39 @@ A more in-depth guide is available at [using primitives](./using-primitives.md).
 `setupLink()` and `linkFor()` to create a link to a route on the fly:
 
 ```ts
-import { module, test } from 'qunit';
-import { setupRenderingTest } from 'ember-qunit';
 import { click, render } from '@ember/test-helpers';
 import { hbs } from 'ember-cli-htmlbars';
+import { module, test } from 'qunit';
+import { setupRenderingTest } from 'ember-qunit';
 
-import { setupLink, linkFor, TestLink } from 'ember-link/test-support';
+import { linkFor, setupLink } from 'ember-link/test-support';
+
+import type { TestContext as BaseTestContext } from '@ember/test-helpers';
+import type { TestLink } from 'ember-link/test-support';
+
+interface TestContext extends BaseTestContext {
+  link: TestLink;
+}
 
 module('`setupLink` example', function (hooks) {
   setupRenderingTest(hooks);
   setupLink(hooks);
 
-  test('`(link)` works in render tests', async function (assert) {
-    const link = linkFor('some.route');
-    link.onTransitionTo = assert.step('link clicked');
+  test('using link in render tests', async function (this: TestContext, assert) {
+    // arrange
+    this.link = linkFor('some.route');
+    this.link.onTransitionTo = () => assert.step('link clicked');
 
     await render(hbs`
-      {{#let (link @route="some.route") as |l|}}
+      {{#let this.link as |l|}}
         <a href={{l.url}} {{on "click" l.open}}>Click me</a>
       {{/let}}
     `);
 
+    // act
     await click('a');
 
+    // assert
     assert.verifySteps(['link clicked']);
   });
 });

diff --git a/docs/testing.md b/docs/testing.md
@@ -51,5 +51,4 @@ module('`setupLink` example', function (hooks) {
     assert.verifySteps(['link clicked']);
   });
 });
-
 ```
diff --git a/ember-link/rollup.config.mjs b/ember-link/rollup.config.mjs
@@ -1,7 +1,6 @@
 import { Addon } from '@embroider/addon-dev/rollup';
 
 import { defineConfig } from 'rollup';
-import copy from 'rollup-plugin-copy';
 import typescript from 'rollup-plugin-ts';
 
 const addon = new Addon({
@@ -52,14 +51,6 @@ export default defineConfig({
     addon.keepAssets(['**/*.css']),
 
     // Remove leftover build artifacts when starting a new build.
-    addon.clean(),
-
-    // Copy Readme and License into published package
-    copy({
-      targets: [
-        { src: '../README.md', dest: '.' },
-        { src: '../LICENSE.md', dest: '.' }
-      ]
-    })
+    addon.clean()
   ]
 });