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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement deployment API support for ant-man and flash previews #960

Merged
merged 14 commits into from
Nov 25, 2020

Conversation

marcoferrer
Copy link
Contributor

@marcoferrer marcoferrer commented Oct 2, 2020

Description

  • Implement deployment API support for ant-man and flash previews.
  • This pr includes two new constants in the Previews class.
  • Getters for newly introduced fields are added to GHDeployment and GHDeploymentStatus.
  • New builder setters are implemented for GHDeploymentBuilder and GHDeploymentStatusBuilder.
  • GHDeploymentState has been updated to support in_progress, queued, and inactive.
  • Marked GHDeploymentStatus.getTargetUrl() and GHDeploymentStatusBuilder.targetUrl() as @Deprecated.
    • Method documentation has been updated to advise users to replace usages with logUrl() where appropriate

Github Blog Posts For Previews Implemented

Before submitting a PR:

We love getting PRs, but we hate asking people for the same basic changes every time.

  • Push your changes to a branch other than master. Create your PR from that branch.
  • Add JavaDocs and other comments
  • Write tests that run and pass in CI. See CONTRIBUTING.md for details on how to capture snapshot data.
  • Run mvn clean compile locally. This may reformat your code, commit those changes.
  • Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.

When creating a PR:

  • Fill in the "Description" above.
  • Enable "Allow edits from maintainers".

@marcoferrer marcoferrer marked this pull request as draft October 2, 2020 20:11
@marcoferrer marcoferrer marked this pull request as ready for review October 2, 2020 21:50
@marcoferrer
Copy link
Contributor Author

@bitwiseman Tests are implemented and this is ready for review. One change that I wanted feedback on was the addition of a value field to the Preview annotation. Thx

@marcoferrer
Copy link
Contributor Author

@bitwiseman friendly bump

Copy link
Member

@bitwiseman bitwiseman left a comment

Choose a reason for hiding this comment

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

Sorry for long delay.

Only one type of change needed. Otherwise looks great.

@marcoferrer
Copy link
Contributor Author

@bitwiseman Feedback addressed. @Deprecated has been added to applicable targets.

@@ -8,11 +8,23 @@
* Indicates that the method/class/etc marked maps to GitHub API in the preview period.
* <p>
* These APIs are subject to change and not a part of the backward compatibility commitment. Always used in conjunction
* with 'deprecated' to raise awareness to clients.
* with 'deprecated' to raise awareness to clients. In addition, it's advised to update the targets documentation to
* signify that the deprecation is required until preview feature being used is promoted to stable.
Copy link
Member

Choose a reason for hiding this comment

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

👍

@bitwiseman bitwiseman merged commit ed4f9c8 into hub4j:master Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants