Merge pull request #7862 from jluk-box/scaffolder-backend-modules-api-docs

Improve API docs in Scaffolder action plugins

plugins/scaffolder-backend-module-cookiecutter/api-report.md

@@ -10,9 +10,7 @@ import { ScmIntegrations } from '@backstage/integration';
 import { TemplateAction } from '@backstage/plugin-scaffolder-backend';
 import { UrlReader } from '@backstage/backend-common';
 
-// Warning: (ae-missing-release-tag) "createFetchCookiecutterAction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export function createFetchCookiecutterAction(options: {
   reader: UrlReader;
   integrations: ScmIntegrations;

plugins/scaffolder-backend-module-cookiecutter/src/actions/fetch/cookiecutter.ts

@@ -121,6 +121,15 @@ export class CookiecutterRunner {
   }
 }
 
+/**
+ * Creates a `fetch:cookiecutter` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://cookiecutter.readthedocs.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
+ * @param options - Templating configuration.
+ * @public
+ */
 export function createFetchCookiecutterAction(options: {
   reader: UrlReader;
   integrations: ScmIntegrations;

plugins/scaffolder-backend-module-cookiecutter/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * A module for the scaffolder backend that lets you template projects using cookiecutter
+ * A module for the scaffolder backend that lets you template projects using {@link https://cookiecutter.readthedocs.io/ | cookiecutter}.
  *
  * @packageDocumentation
  */

plugins/scaffolder-backend-module-rails/api-report.md

@@ -8,9 +8,7 @@ import { ScmIntegrations } from '@backstage/integration';
 import { TemplateAction } from '@backstage/plugin-scaffolder-backend';
 import { UrlReader } from '@backstage/backend-common';
 
-// Warning: (ae-missing-release-tag) "createFetchRailsAction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export function createFetchRailsAction(options: {
   reader: UrlReader;
   integrations: ScmIntegrations;

plugins/scaffolder-backend-module-rails/src/actions/fetch/rails/index.ts

@@ -27,6 +27,16 @@ import {
 import { resolve as resolvePath } from 'path';
 import { RailsNewRunner } from './railsNewRunner';
 
+/**
+ * Creates the `fetch:rails` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://guides.rubyonrails.org/rails_application_templates.html} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
+ *
+ * @param options - Configuration of the templater.
+ * @public
+ */
 export function createFetchRailsAction(options: {
   reader: UrlReader;
   integrations: ScmIntegrations;

plugins/scaffolder-backend-module-rails/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * A module for the scaffolder backend that lets you template projects using Rails
+ * A module for the scaffolder backend that lets you template projects using {@link https://guides.rubyonrails.org/rails_application_templates.html | Rails}.
  *
  * @packageDocumentation
  */

plugins/scaffolder-backend-module-yeoman/api-report.md

@@ -5,10 +5,6 @@
 ```ts
 import { TemplateAction } from '@backstage/plugin-scaffolder-backend';
 
-// Warning: (ae-missing-release-tag) "createRunYeomanAction" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export function createRunYeomanAction(): TemplateAction<any>;
-
-// (No @packageDocumentation comment for this package)
 ```

plugins/scaffolder-backend-module-yeoman/src/actions/run/yeoman.ts

@@ -18,6 +18,15 @@ import { JsonObject } from '@backstage/types';
 import { createTemplateAction } from '@backstage/plugin-scaffolder-backend';
 import { yeomanRun } from './yeomanRun';
 
+/**
+ * Creates a `run:yeoman` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://yeoman.io/} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
+ *
+ * @public
+ */
 export function createRunYeomanAction() {
   return createTemplateAction<{
     namespace: string;

plugins/scaffolder-backend-module-yeoman/src/index.ts

@@ -13,4 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/**
+ * A module for the scaffolder backend that lets you template projects using
+ * {@link https://yeoman.io/ | Yeoman}.
+ *
+ * @packageDocumentation
+ */
 export * from './actions';