Skip to content

Actions: Add deprecationMessage metadata syntax field #4945

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 7, 2021
Merged

Actions: Add deprecationMessage metadata syntax field #4945

merged 3 commits into from
Apr 7, 2021

Conversation

Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Mar 30, 2021 •
edited
Loading

Why:

Document this useful feature for everyone. Discovered on github.community

What's being changed:

  • Add description for deprecationMessage
  • Mark two variables as inline code

Check off the following:

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 30, 2021
@Simran-B
Copy link
Contributor Author

actions.yml example:

name: Test
description: Action Test
inputs:
  obsolete:
    description: An option to test the deprecationMessage property
    deprecationMessage: This option should no longer be used!

How it looks like in the log:

image

@janiceilene janiceilene added actions This issue or pull request should be reviewed by the docs actions team and removed triage Do not begin working on this issue until triaged by the team labels Mar 31, 2021
@janiceilene
Copy link
Contributor

@Simran-B Thanks so much for opening a PR 🙌 It's good to see you around! I'll get this triaged for review 👍

@janiceilene janiceilene added the waiting for review Issue/PR is waiting for a writer's review label Mar 31, 2021
@martin389 martin389 self-assigned this Apr 1, 2021
@Simran-B
Copy link
Contributor Author

Simran-B commented Apr 1, 2021

Applied the suggestion!

I think it's fine to not have an example showing use usage of deprecationMessage as it's not something you commonly do and it's straightforward anyway.

@martin389
Copy link
Contributor

👋 Status update: Checking with dev team

konradpabjan
konradpabjan approved these changes Apr 7, 2021
View reviewed changes
Copy link
Contributor

@konradpabjan konradpabjan 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 to me! 👍

@martin389
Copy link
Contributor

martin389 commented Apr 7, 2021 •
edited
Loading

Looks good in staging: https://docs-4945--patch-1.herokuapp.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddeprecationmessage
(this link will stop working once the PR has merged)

@martin389 martin389 merged commit c16a17b into github:main Apr 7, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Apr 7, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

@Simran-B Simran-B deleted the patch-1 branch April 8, 2021 08:18
@jmarshall jmarshall mentioned this pull request May 26, 2021
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martin389 martin389 martin389 left review comments

@konradpabjan konradpabjan konradpabjan approved these changes

Assignees

@martin389 martin389

Labels
actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Simran-B @janiceilene @martin389 @konradpabjan @Karl9912