Mailing-List: contact commits-help@beam.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@beam.apache.org
Date: Tue, 2 May 2017 17:07:04 +0000 (UTC)
From: "ASF GitHub Bot (JIRA)" <jira@apache.org>
To: commits@beam.apache.org
Message-ID: <JIRA.13038817.1485749774000.104650.1493744824793@Atlassian.JIRA>
In-Reply-To: <JIRA.13038817.1485749774000@Atlassian.JIRA>
References: <JIRA.13038817.1485749774000@Atlassian.JIRA> <JIRA.13038817.1485749774848@jira-lw-us.apache.org>
Subject: [jira] [Commented] (BEAM-1345) Mark @Experimental pieces of the SDK
 that have been added but are not ready to be frozen
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Tue, 02 May 2017 17:07:11 -0000


    [ https://issues.apache.org/jira/browse/BEAM-1345?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15993293#comment-15993293 ] 

ASF GitHub Bot commented on BEAM-1345:
--------------------------------------

GitHub user tgroh opened a pull request:

    https://github.com/apache/beam/pull/2830

    [BEAM-1345] Add an @Internal Annotation

    Be sure to do all of the following to help us incorporate your contribution
    quickly and easily:
    
     - [ ] Make sure the PR title is formatted like:
       `[BEAM-<Jira issue #>] Description of pull request`
     - [ ] Make sure tests pass via `mvn clean verify`.
     - [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
           number, if there is one.
     - [ ] If this contribution is large, please file an Apache
           [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
    
    ---
    This annotation is used as a marker that a publicly accessible API is
    intended for internal use and should not be used by users, and is
    subject to no compatibility guarantees.
    

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/tgroh/beam add_internal_annotation

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/beam/pull/2830.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2830
    
----
commit 7b3cce4da29bad280e42e2490ee3dc4ef5d4f763
Author: Thomas Groh <tgroh@google.com>
Date:   2017-05-02T17:02:22Z

    Add an @Internal Annotation
    
    This annotation is used as a marker that a publicly accessible API is
    intended for internal use and should not be used by users, and is
    subject to no compatibility guarantees.

----


> Mark @Experimental pieces of the SDK that have been added but are not ready to be frozen
> ----------------------------------------------------------------------------------------
>
>                 Key: BEAM-1345
>                 URL: https://issues.apache.org/jira/browse/BEAM-1345
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-java-core, sdk-java-extensions, sdk-java-gcp
>            Reporter: Kenneth Knowles
>              Labels: backward-incompatible
>             Fix For: First stable release
>
>
> A blanket JIRA to ensure that before a stable release we make sure to mark those pieces that would be unwise to freeze yet and consider how best to communicate this to users, who may just autocomplete those features in their IDE anyhow. (conversely, put infrastructure in place to enforce freezing of the rest)
> Not technically "backwards incompatible" with pre-Beam Dataflow SDKs, but certainly needs to be on the burndown for the first stable release.


--
This message was sent by Atlassian JIRA
(v6.3.15#6346)